[CRIU] [PATCH 4/4] criu2text: add README

[Ruslan Kuprieiev]

Some notes about how to build, use and test criu2text.
Wiki page is comming soon.

Signed-off-by: Ruslan Kuprieiev <kupruser at gmail.com>
---
 tools/criu2text/README | 51 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 51 insertions(+)
 create mode 100644 tools/criu2text/README

diff --git a/tools/criu2text/README b/tools/criu2text/README
new file mode 100644
index 0000000..f05c1d7
--- /dev/null
+++ b/tools/criu2text/README
@@ -0,0 +1,51 @@
+criu2text
+
+Convert criu images to/from set of files in human-readable format
+
+Building:
+     Specify PROTOBUF_DIR, MAGIC_C_HEADER and CRIU
+     variables in Makefile if you are building
+     criu2text not from criu/tools/criu2text.
+
+     Run:
+        make
+     to generate magic.py and compile needed
+     protobuf messages.
+
+     Run:
+        make test
+     to dump simple loop and convert it's images
+     to text and back and compare them bit by bit.
+
+     Run:
+        make clean
+     to cleanup.
+
+Usage:
+	criu2text [-h] [-o OUT] {to-text,to-img} image
+
+	positional arguments:
+	  {to-text,to-img}   to what type convert input file(s)
+	  image              path to criu image or base path to criu image
+			     files in human-readable format (e.g. ./imgs/core-1234.img)
+
+	optional arguments:
+	  -h, --help         show this help message and exit
+	  -o OUT, --out OUT  directory where output file(s) should be placed
+
+	Examples:
+	1) Convert ./core-1234.img to set of text files (core-1234.img.magic,
+	   core-1234.img.0) and place them at text_imgs_dir.
+
+	       $ criu2text to-text core-1234.img -o text_imgs_dir
+	       $ ls text_imgs_dir
+	       core-1234.img.magic
+	       core-1234.img.0
+
+	2) Convert text_imgs_dir/core-1234.img.magic, text_imgs_dir/core-1234.img.0
+	   (note common base text_imgs_dir/core-1234.img, which we're specifying)
+	   to criu img format and place it at imgs_dir.
+
+	       $ criu2text to-img text_imgs_dir/core-1234.img -o imgs_dir
+	       $ ls imgs_dir
+	       core-1234.img
-- 
1.9.3