doc+src: More reorganization and fixing of README
Change-Id: I8ff2dcdabd78f38cc0d5b826883121a9444ef664
diff --git a/README.md b/README.md
index 6c66ba2..ace6f72 100644
--- a/README.md
+++ b/README.md
@@ -1,37 +1,51 @@
-Traffic Generator For NDN (ndn-traffic)
-=======================================
+Traffic Generator For NDN (ndn-traffic-generator)
+=================================================
This tool is designed to generate interest and data traffic in an NDN network.
The client and server tool accept traffic configuration files which can be
used to specify the pattern of NDN traffic that is required to be generated.
-Sample configuration files are provided which include instructions on how
-to configure various parameters.
+Sample configuration files are provided which include instructions on how
+to configure various parameters.
-This is an application tool developed over ndn-cpp APIs for TLV packet
-based communication over NDN configured network. The NDN network has to
-be first created with 'ndnx' and 'ndnd-tlv'. This is followed by environment
-security setup with 'ndn-cpp-security-tools'. The application also requires
-installation of ndn-cpp and CPP boost libraries. The installations need to
-follow a strict order as the ndnd
+## Prerequisites ##
-To run the following must be ensured(FOLLOW ORDER STRICTLY)
+Compiling and running ndn-traffic-generator requires the following dependencies:
-1. Install ndnx (install all necessary dependencies)
-2. Install CPP Boost Library > 1.47
+1. C++ Boost Libraries version >= 1.48
+
+ On Ubuntu 12.04:
sudo apt-get install libboost1.48-all-dev
-3. Install ndn-cpp-dev (install all necessary dependencies except boost)
-4. Install ndnd-tlv install all necessary dependencies except boost)
-5. Install and Configure Security Environment with ndn-cpp-security-tools
+ On Ubuntu 13.10 and later
+
+ sudo apt-get install libboost-all-dev
+
+ On OSX with macports
+
+ sudo port install boost
+
+ On OSX with brew
+
+ brew install boost
+
+ On other platforms Boost Libraries can be installed from the packaged version for the
+ distribution, if the version matches requirements, or compiled from source
+ (http://www.boost.org)
+
+2. ndn-cpp-dev library (https://github.com/named-data/ndn-cpp-dev)
+
+ For detailed installation instructions refer to
+ https://github.com/named-data/ndn-cpp-dev/blob/master/INSTALL.md and/or
+ https://github.com/named-data/ndn-cpp-dev
+
+3. NDN forwarding daemon (https://github.com/named-data/NFD)
-----------------------------------------------------
## 1. Compile And Installation Instructions: ##
- git clone git://github.com/jeraldabraham/ndn-traffic ndn-traffic
- cd ndn-traffic
- ./waf configure
+ ./waf configure
./waf
sudo ./waf install
@@ -57,26 +71,21 @@
__ON MACHINE #1__
-Start the ndnd-tlv daemon
-
- ndnd-tlv-start
+(NDN forwarding daemon should be running)
Start traffic server
- ndntrafficserver NDNTrafficServer.conf
+ ndn-traffic-server ndn-traffic-server.conf
__ON MACHINE #2__
-Start the ndnd-tlv daemon
-
- ndnd-tlv-start
+(NDN forwarding daemon should be running)
Start the traffic client
-
- ndntraffic NDNTrafficClient.conf
+
+ ndn-traffic ndn-traffic-client.conf
* These tools need not be used together and can be used individually as well.
* Please refer sample configuration files provided for details on how to create your own.
* Use command line options shown above to adjust traffic configuration.
-