* update README

README

@@ -1,29 +0,0 @@
-== Overview ==
-  Set of programs to convert binary encoded torrent files to human readable
-json and back.
-  Acts as standart unix "filter" program: reads stdin, writes to stdout.
-
-== Requirements ==
-cmake - for building only, can be removed later
-yajl - yet another json library (http://lloyd.github.com/yajl/)
-
-== Compiling ==
-$ cmake .
-$ make
-# make install
-
-You may also do "out of tree" builds, like this:
-$ mkdir .build && cd .build
-$ cmake ..
-$ make
-# make install
-... and all changes: new files, object modules, Makefile's, and so on will
-be located in this dir.
-
-For build with debugging information add the following to cmake options:
-"-DCMAKE_BUILD_TYPE=Debug"
-
-== Authors ==
-This utilites originally written by two peoples: michail and h4tr3d.
-If you want to contact them, look there -> http://linuxdv.ru
-

README.md

@@ -0,0 +1,35 @@
+Overview
+--------
+
+Set of programs to convert binary encoded torrent files to human readable
+json and back. Acts as standart unix "filter" program: reads stdin, writes to stdout.
+
+Requirements
+------------
+
+* cmake - for building only, can be removed later
+* yajl - yet another json library (http://lloyd.github.com/yajl/)
+
+Installation
+------------
+
+    cmake -DCMAKE_BUILD_TYPE=Release .
+    make
+    sudo make install # optional
+
+You may also do "out of tree" builds, like this:
+
+    mkdir .build && cd .build
+    cmake ..
+    make
+    sudo make install # optional
+
+... and all changes: new files, object modules, Makefile's, and so on will be located in this dir.
+
+For build with debugging information set CMAKE_BUILD_TYPE to "Debug".
+
+Authors
+-------
+
+This utilites originally written by two peoples: michail_ul and h4tr3d.
+If you want to contact them, look there -> http://linuxdv.org