docs: initial README and INSTALL

refs #2673

Change-Id: I09978bdba2ff8f21d8d959f18f4d9fab442baad7
This commit is contained in:
Junxiao Shi committed 2015-03-26 23:14:19 -07:00
1 parent 0c75f99be4
commit 6ca4881da8
2 files changed
+45

No files matched your search

+29
View File
@@ -0,0 +1,29 @@
# ndn-tools Build Instructions
This document describes how to build and install ndn-tools.
## Prerequisites
Building ndn-tools requires [ndn-cxx](http://named-data.net/doc/ndn-cxx/current/)
to be installed.
Please see [Getting Started with ndn-cxx](http://named-data.net/doc/ndn-cxx/current/INSTALL.html)
on how to install ndn-cxx.
Note: if you have installed ndn-cxx from a binary package, please make sure development headers
are installed (if using Ubuntu PPA, `ndn-cxx-dev` package is needed).
Any operating system and compiler supported by ndn-cxx are supported by ndn-tools.
## Build Steps
Waf meta build system is used by ndn-tools.
To configure, compile, and install ndn-tools, type the following commands
in ndn-tools source directory:
./waf configure
./waf
sudo ./waf install
To uninstall ndn-tools:
sudo ./waf uninstall
+16
View File
@@ -0,0 +1,16 @@
# NDN Essential Tools
**ndn-tools** is a collection of essential tools for
[Named Data Networking](http://named-data.net/).
These tools are recommended to be installed on all NDN nodes.
Tools in this collection include:
* [ping](tools/ping): test reachability between two nodes
* [peek](tools/peek): transmit a single packet between a consumer and a producer
See [INSTALL.md](INSTALL.md) for build instructions.
Please file bug reports and feature requests on
[ndn-tools Redmine site](http://redmine.named-data.net/projects/ndn-tools).
You may contribute code on [NDN Gerrit](http://gerrit.named-data.net).
GitHub pull requests are not accepted.