From f7010b80614d0858e21bd661f95a4847ee00c77a Mon Sep 17 00:00:00 2001
From: "James O. D. Hunt" <james.o.hunt@intel.com>
Date: Mon, 10 Oct 2022 10:09:56 +0100
Subject: [PATCH] kata-ctl: docs: Write basic documentation

Provide a basic document explaining a little about the `kata-ctl`
command.

Fixes: #5351.

Signed-off-by: James O. D. Hunt <james.o.hunt@intel.com>
---
 src/tools/kata-ctl/README.md | 42 ++++++++++++++++++++++++++++++++----
 1 file changed, 38 insertions(+), 4 deletions(-)

diff --git a/src/tools/kata-ctl/README.md b/src/tools/kata-ctl/README.md
index 1e441d58b2..bf908f60d0 100644
--- a/src/tools/kata-ctl/README.md
+++ b/src/tools/kata-ctl/README.md
@@ -2,14 +2,48 @@
 
 ## Overview
 
+The `kata-ctl` tool is a rust rewrite of the
+[`kata-runtime`](../../runtime/cmd/kata-runtime)
+[utility program](../../../docs/design/architecture/README.md#utility-program).
+
+The program provides a number of utility commands for:
+
+- Using advanced Kata Containers features.
+- Problem determination and debugging.
+
 ## Audience and environment
 
-## History
+Users and administrators.
 
-## Full details
+## Build the tool
 
-## Code summary
+```bash
+$ make
+```
+
+## Install the tool
+
+```bash
+$ make install
+```
 
 ## Run the tool
 
-### Prerequisites
+```bash
+$ kata-ctl ...
+```
+
+For example, to determine if your system is capable of running Kata
+Containers, run:
+
+```bash
+$ kata-ctl check all
+```
+
+### Full details
+
+For a usage statement, run:
+
+```bash
+$ kata-ctl --help
+```