write simple documentation

Author: xiaopeng163

README.rst

@@ -122,7 +122,6 @@ TODO
 
 -  support more address family (IPv6, VPNv4, VPNv6, etc.)
 -  support RESTful API, send message/control peer state, etc.
--  documentation
 -  unittest
 -  others
 

doc/README.md

@@ -12,17 +12,49 @@ of routers (include real Cisco/HuaWei/Juniper routers and some router
 simulators in Cisco like IOL/IOU) and receive/parse BGP messages for
 future analysis. Now we open sourced it.
 
-We write it in strict accordance with the specifications of RFCs.
+We write it accordance with the specifications of RFCs.
 
 This software can be used on Linux/Unix, Mac OS and Windows systems.
 
+Features
+========
+
+-  It can establish BGP session based on IPv4 address (TCP Layer) in
+   active mode(as TCP client);
+
+-  Support TCP MD5 authentication(IPv4 and does not support Windows
+   now);
+
+-  BGP capabilities support: 4 Bytes ASN, IPv4 address family, Route
+   Refresh(Cisco Route Refresh);
+
+-  Decode all BGP messages to human readable strings and write files to
+   disk(configurable);
+
+.. note::
+
+  yabgp is a light weight BGP agent used for connecting network devices. It only can be
+  TCP client in one BGP peering connection, and we recommend that each yabgp process connect
+  only one BGP neighbor, so each process is independent with each other, we can start many yabgp
+  processes within the same machine or in different machines.
 
 Quickstarts
 ===========
 
 .. toctree::
    :maxdepth: 1
 
+   install
+   tutorial
+   msg_format
+   reference
+
+Support
+=======
+
+Please use GitHub issue system or submit pull request.
+
+
 Indices and tables
 ==================
 

doc/source/index.rst

@@ -0,0 +1,34 @@
+Installation
+============
+
+We recommend run ``yabgp`` through python virtual-env from source
+code or pip install
+
+Use yabgp from source code:
+
+.. code:: bash
+
+    $ virtualenv yabgp-virl
+    $ source yabgp-virl/bin/activate
+    $ git clone https://github.com/yabgp/yabgp
+    $ cd yabgp
+    $ pip install -r requirements.txt
+    $ cd bin
+    $ python yabgpd -h
+
+Use pip install
+
+.. code:: bash
+
+    $ virtualenv yabgp-virl
+    $ source yabgp-virl/bin/activate
+    $ pip install yabgp
+    $ which yabgpd
+    /home/bgpmon/yabgp-virl/bin/yabgpd
+    $ yabgpd -h
+
+.. note::
+
+    For ``virtualenv``, you can install it from pip. And make sure you have installed ``python-dev`` based on
+    your operation system, for example Ubuntu, you can install it from ``apt-get install python-dev``.
+    otherwise, you may get error when install requirement from requirements.txt