reformat readme
authorMyhailo Danylenko <isbear@ukrpost.net>
Fri, 17 Aug 2012 17:03:25 +0300
changeset 22 37d7ae649929
parent 21 e453791d6ca8
child 23 1615b3d8040d
reformat readme
docs/readme.mdwn
--- a/docs/readme.mdwn	Fri Aug 17 16:55:45 2012 +0300
+++ b/docs/readme.mdwn	Fri Aug 17 17:03:25 2012 +0300
@@ -1,40 +1,44 @@
 
-Welcome to Yet Another Useless Built-In Language.
-It provides conditional and blocking constructs, as well
-as some arithmetic expression evaluation and string
+# Welcome to Yet Another Yuseless Built-In Language!
+
+It provides conditional, loop and composition expressions,
+as well as some arithmetic expression evaluation and string
 concatenation. String splitting is not yet implemented,
 but is planned.
 
-INSTALLATION
+# Installation
 
 To install it, you need:
-cmake
-make
-gcc
-glib
-mcabber headers
+
+ * cmake
+ * make
+ * gcc
+ * glib
+ * mcabber headers
 
 Then do
-$ mkdir build
-$ cd build
-$ cmake ..
-$ make edit_cache
-$ make
-# make install
+
+    $ mkdir build
+    $ cd build
+    $ cmake ..
+    $ make edit_cache
+    $ make
+    # make install
 
 Debian users can instead of make install do
-$ fakeroot make package
-# dpkg -i libmcbber-yaubil*.deb
+
+    $ fakeroot make package
+    # dpkg -i libmcbber-yaubil*.deb
 
 Users of other distributions can select appropriate package
 generator, using cache editor.
 
-LICENSE
+# License
 
 This code underlies terms of GNU GPL v2 or later. You can find it in file COPYING
 from this distribution or on a GNU web-site <http://www.gnu.org/licenses/>.
 
-CONTACTS
+# Contact
 
 I will be happy to get feedback, patches, suggestions, etc.
 You can send me email or contact via jabber <isbear@unixzone.org.ua>.