doc: Updating build instructions
Change-Id: Id2191864195241058eb3063f099bf7d97e78bb72
diff --git a/.travis.yml b/.travis.yml
index e9fd66e..3199dc8 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -8,16 +8,14 @@
before_install:
- travis_retry sudo add-apt-repository -y ppa:named-data/ppa
- travis_retry sudo apt-get update -qq
- - travis_retry sudo apt-get install -qq autotools-dev
- travis_retry sudo apt-get install -qq ndnx-dev
- travis_retry sudo apt-get install -qq libboost-all-dev
- travis_retry sudo apt-get install -qq libcrypto++-dev
- travis_retry sudo apt-get install -qq libsqlite3-dev
script:
- - autoreconf -f --install
- - ./configure --with-tests
- - make
- - sudo make install
+ - ./waf configure --with-tests
+ - ./waf
+ - sudo ./waf install
- sudo ldconfig
- #
- # Some tests now require daemon to run (and daemon needs the library to be compiled)
@@ -32,4 +30,4 @@
- ndnd-tlv-start
- sleep 1
- #
- - ./tests_boost/unit-tests -l all
+ - ./build/tests/unit-tests -l all
diff --git a/INSTALL b/INSTALL
deleted file mode 100644
index 3caf65b..0000000
--- a/INSTALL
+++ /dev/null
@@ -1,109 +0,0 @@
-NDN-CPP: A Named Data Networking client library for C++ and C
--------------------------------------------------------------
-
-Prerequisites
--------------
-(These are prerequisites to build NDN-CPP. To do development of NDN-CPP code and update the build system,
- see Development Prerequisites.)
-
-Required:
-
-* libcrypto
-* libsqlite3
-* libcrypto++
-
-Optional:
-
-* boost libraries (highly recommended)
-* OSX Security framework (for key storage)
-
-Following are the detailed steps for each platform to install the prerequisites.
-
-* Mac OS X 10.7.3, Mac OS X 10.8.4
-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
-
-* Ubuntu 12.04 (64 bit and 32 bit), Ubuntu 13.04 (64 bit)
-In a terminal, enter:
-
- sudo apt-get install build-essential
- sudo apt-get install libboost-all-dev libssl-dev libsqlite3-dev libcrypto++-dev
-
-* Windows Cygwin
-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.
-
-Build
------
-(These are instructions to build NDN-CPP. To do development of NDN-CPP code and update the build system, see Development.)
-
-To build in a terminal, change directory to the NDN-CPP root. Enter:
-
- ./configure
- make
- make install
-
-To make documentation, enter:
-
- make doxygen-doc
-
-Files
------
-
-This makes the following libraries:
-
-.libs/libndn-c.a: The core C code for encoding and communication.
-.libs/libndn-cpp.a: The C++ library API. (If linking to libndn-cpp, don't link to libndn-c since it is included.)
-
-This makes the following test files:
-
-bin/test-get-async: Connect to one of the NDN testbed hubs, express an interest and display the received data.
-bin/test-publish-async: Connect to the local NDN hub, accept interests with prefix /testecho and echo back a data packet.
-bin/test-encode-decode-interest: Encode and decode an interest, testing interest selectors and the name URI.
-bin/test-encode-decode-data: Encode and decode a data packet, including signing the data packet.
-bin/test-encode-decode-forwarding-entry: Encode and decode a data packet, including signing the data packet.
-
-Running make doxygen-doc puts code documentation in:
-doc/html
-
-Supported platforms
--------------------
-
-NDN-CPP is tested on the following platforms:
-Ubuntu 12.04 (64 bit and 32 bit) (gcc 4.6.3)
-Ubuntu 13.04 (64 bit) (gcc 4.7.3)
-Mac OS X 10.8.4 (clang 4.2)
-Mac OS X 10.8.4 (gcc 4.2)
-
-Development Prerequisites
--------------------------
-These steps are only needed to do development of NDN-CPP code and update the build system.
-First follow the Prerequisites above for your platforms.
-
-* Mac OS X 10.7.3, Mac OS X 10.8.4, Mac OS X 10.9
-Install MacPorts from http://www.macports.org/install.php
-In a terminal, enter:
-sudo port install automake
-sudo port install autoconf
-sudo port install libtool
-sudo port install doxygen
-
-* Ubuntu 12.04 (64 bit and 32 bit), Ubuntu 13.04 (64 bit)
-In a terminal, enter:
-sudo apt-get install automake
-sudo apt-get install libtool
-sudo apt-get install doxygen
-
-Development
------------
-Follow Development Prerequisites above for your platform.
-Now you can add source code files and update Makefile.am.
-After updating, change directory to the NDN-CPP root and enter the following to build the Makefile:
-./autogen.sh
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..65690a6
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,117 @@
+NDN-CPP-dev: A dev version of Named Data Networking client library for C++
+===========================================================================
+
+Prerequisites
+-------------
+
+(These are prerequisites to build NDN-CPP. To do development of NDN-CPP code and update the build system,
+ see Development Prerequisites.)
+
+Required:
+
+* libcrypto
+* libsqlite3
+* libcrypto++
+* boost libraries
+* 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
+
+ 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
+
+* Ubuntu 12.04 (64 bit and 32 bit), Ubuntu 13.04 (64 bit)
+
+ In a terminal, enter:
+
+ sudo apt-get install build-essential
+ sudo apt-get install libboost-all-dev libssl-dev libsqlite3-dev libcrypto++-dev
+
+* Windows Cygwin
+
+ 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.
+
+Build
+-----
+
+(These are instructions to build NDN-CPP. To do development of NDN-CPP code and update the build system, see Development.)
+
+To build in a terminal, change directory to the NDN-CPP root. Enter:
+
+ ./waf configure
+ ./waf
+ sudo ./waf install
+
+This makes 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
+ 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
+ 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
+
+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
+
+Documentation
+-------------
+
+To make documentation, enter:
+
+ ./waf doxygen
+
+This will produce doxygen API code documentation in:
+
+* build/doc/html
+
+Supported platforms
+-------------------
+
+(to be confirmed)
+
+NDN-CPP is tested on the following platforms:
+Ubuntu 12.04 (64 bit and 32 bit) (gcc 4.6.3)
+Ubuntu 13.04 (64 bit) (gcc 4.7.3)
+Mac OS X 10.8.4 (clang 4.2)
+Mac OS X 10.8.4 (gcc 4.2)
+
+Development Prerequisites
+-------------------------
+
+These steps are only needed to do development of NDN-CPP code and update the build system.
+First follow the Prerequisites above for your platforms.
+
+* Mac OS X 10.7.3, Mac OS X 10.8.4, Mac OS X 10.9
+
+ Install MacPorts from http://www.macports.org/install.php
+ In a terminal, enter:
+
+ sudo port install doxygen
+
+* Ubuntu 12.04 (64 bit and 32 bit), Ubuntu 13.04 (64 bit)
+
+ In a terminal, enter:
+
+ sudo apt-get install doxygen
+
+Development
+-----------
+
+Follow Development Prerequisites above for your platform.