Improve installation info.
[command.git] / README
diff --git a/README b/README
index 6166838232e757c45c0e152ffaa02c15290d5b6f..b7121a20c33e0573c0eb3ae193b5892344af8db6 100644 (file)
--- a/README
+++ b/README
@@ -1,12 +1,22 @@
 # Command
 
-C++ library for handling command line arguments, designed to be easily used.
+C++ library for handling command line arguments.
 
 ## Installation
-1. $ ./autogen.sh
-2. $ ./configure
-3. $ make
-4. $ sudo make install
+
+### debian package
+
+    $ wget https://github.com/quayle/command/releases/download/v0.2.1-deb/command_0.2.1_all.deb
+    $ sudo dpkg -i command_0.2.1_all.deb
+
+### from sources
+
+You will need to have autotools installed (automake, autoconf, ...)
+
+    $ ./autogen.sh
+    $ ./configure
+    $ make
+    $ sudo make install
 
 ## Configuration
 
@@ -43,3 +53,11 @@ Now program can be compiled & run using following commands:
     $ g++ -std=c++11 example.cpp
     $ ./a.out -h
     Help information
+
+## Documentation
+
+Current documentation can be found at:
+http://dlugolecki.net.pl/software/command/docs/
+
+If for some reason it is unavailable, you can build it yourself. The only
+requirement is to have [Doxygen](http://www.doxygen.org/) installed when `make` command is invoked.