docs: Updated installation instructions, AUTHORs, and other small updates
Change-Id: Ide2046742254255322e8cb84279ffd6a4ecb9b4b
diff --git a/INSTALL.md b/INSTALL.md
index 04d7c3b..9b0e57c 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -1,6 +1,17 @@
ndn-cpp-dev: A dev version of Named Data Networking client library for C++
===========================================================================
+Supported platforms
+-------------------
+
+ndn-cpp-dev is tested on the following platforms:
+
+* Ubuntu 12.04 (64 bit and 32 bit)
+* Ubuntu 13.10 (64 bit and 32 bit)
+* Mac OS X 10.8
+* Mac OS X 10.9
+
+
Prerequisites
-------------
@@ -9,42 +20,37 @@
Required:
-* libcrypto
-* libsqlite3
-* libcrypto++
-* boost libraries (>= 1.48)
+* `python` >= 2.6
+* `libcrypto`
+* `libsqlite3`
+* `libcrypto++`
+* `pkg-config`
+* Boost libraries >= 1.48
* OSX Security framework (on OSX platform only)
Following are the detailed steps for each platform to install the prerequisites.
-* Mac OS X 10.7.3, Mac OS X 10.8.4
+* Mac OS X
Install Xcode.
In Xcode Preferences > Downloads, install "Command Line Tools".
-* Mac OS X 10.9
-
- Install Xcode. (Xcode on OS X 10.9 seems to already have the Command Line Tools.)
-
If using macports, dependencies can be installed using the following commands:
- sudo port install boost sqlite3 libcryptopp
+ sudo port install pkgconfig boost sqlite3 libcryptopp
* Ubuntu 12.04, Ubuntu 13.10
In a terminal, enter:
sudo apt-get install build-essential
- # For Ubuntu 12.04
- sudo apt-get install libboost1.48-all-dev
- # For Ubuntu 13.10
- sudo apt-get install libboost-all-dev
sudo apt-get install libssl-dev libsqlite3-dev libcrypto++-dev
-* Windows Cygwin
+ # For Ubuntu 12.04
+ sudo apt-get install libboost1.48-all-dev
- Cygwin is tested on Windows 7 64-bit with the "Devel" packages selected to install at the top level of the
- cygwin installer. This includes libcrypto and libsqlite3.
+ # For Ubuntu 13.10
+ sudo apt-get install libboost-all-dev
Build
-----
@@ -58,22 +64,24 @@
./waf
sudo ./waf install
-This makes and installs the following items:
+This builds and installs the following items:
-* ``<LIBPATH>/libndn-cpp-dev.*``: static and dynamic NDN C++ libraries
-* ``<LIBPATH>/pkgconfig/libndn-cpp-dev.pc``: pkgconfig file storing all neccessary flags
+* `<LIBPATH>/libndn-cpp-dev.a`: static NDN C++ library
+* `<LIBPATH>/pkgconfig/libndn-cpp-dev.pc`: pkgconfig file storing all neccessary flags
to build against the library. For example, if pkgconfig or pkgconf package is
- installed and PKG_CONFIG_PATH is configured properly (or ``<LIBPATH>/pkgconfig`` is a
- default path), ``pkgconfig --libs --clflags libndn-cpp-dev`` will return all necessary
+ installed and `PKG_CONFIG_PATH` is configured properly (or `<LIBPATH>/pkgconfig` is a
+ default path), `pkgconfig --libs --clflags libndn-cpp-dev` will return all necessary
compile and link flags for the library.
-* ``<BINPATH>/tlvdump``: a simple tool to dump contents of TLV-formatted data
-* ``<BINPATH>/ndncatchunks3``: a simplified equivalent to ndncatchunks2 in NDNx package
-* ``<BINPATH>/ndnputchunks3``: a simplified equivalent to ndnputchunks2 in NDNx package
+* `<BINPATH>/tlvdump`: a simple tool to dump contents of TLV-formatted data
+* `<BINPATH>/ndncatchunks3`: a simplified equivalent to ndncatchunks2 in NDNx package
+* `<BINPATH>/ndnputchunks3`: a simplified equivalent to ndnputchunks2 in NDNx package
+* `<BINPATH>/ndnsec`: tool to manage NDN keys and certificates
+* `<BINPATH>/ndnsec-*`: convenience scripts for `ndnsec` tools
-If configured with tests: ``./waf configure --with-tests``), the above commands will
+If configured with tests: `./waf configure --with-tests`), the above commands will
also produce:
-* ``build/tests/unit-tests``: A tool to run unit tests for the library
+* `build/unit-tests`: A unit test binary for the library
Documentation
-------------
@@ -84,19 +92,7 @@
This will produce doxygen API code documentation in:
-* build/doc/html
-
-Supported platforms
--------------------
-
-(to be confirmed)
-
-ndn-cpp-dev is tested on the following platforms:
-
-* Ubuntu 12.04 (64 bit and 32 bit)
-* Ubuntu 13.10 (64 bit and 32 bit)
-* Mac OS X 10.8
-* Mac OS X 10.9
+* `build/doc/html`
Development Prerequisites
-------------------------
@@ -117,7 +113,17 @@
sudo apt-get install doxygen
-Development
------------
+Development Build
+-----------------
-Follow Development Prerequisites above for your platform.
+The following is the suggested configure commands for development build.
+
+ ./waf configure --debug --with-tests
+ ./waf
+ sudo ./waf install
+
+In the development build all compiler optimizations are disabled by default and all warnings are treated as error.
+The default behavior can be overridden by setting CXXFLAGS environment variable before running `./waf configure`:
+
+ CXXFLAGS="-O1 -g3" ./waf configure --debug --with-tests
+ ...