[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 | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 tools/criu2text/README

diff --git a/tools/criu2text/README b/tools/criu2text/README
new file mode 100644
index 0000000..60a45f5
--- /dev/null
+++ b/tools/criu2text/README
@@ -0,0 +1,35 @@
+criu2text
+
+criu images to/from google protobuf text 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 to-text IMG_IN [WORK_DIR]
+       criu2text to-img TEXT_DIR_IN [WORK_DIR]
+
+Examples:
+     1) $ criu2text to-text core-1234.img text_imgs_dir
+        $ ls text_imgs_dir
+          core-1234
+        $ ls text_imgs_dir/core-1234
+          0
+          magic
+
+     2) $ criu2text to-img text_imgs_dir/core-1234 imgs_dir
+        $ ls imgs_dir
+          core-1234.img
-- 
1.9.3