| commit | 7c6aeb0827455a0710172155d3077bbed969176f | [log] [tgz] |
|---|---|---|
| author | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Thu Apr 10 19:59:19 2014 -0700 |
| committer | Alexander Afanasyev <alexander.afanasyev@ucla.edu> | Fri Apr 11 11:08:46 2014 -0700 |
| tree | 67cc84ad8c3762e1200d11592b79b9f93652341f | |
| parent | 53af7a18446b59aea56755f485a84e16973612f8 [diff] |
docs: Importing initial set of library documentation from wiki
To build documentation, doxygen (+graphviz dot) and sphinx-build are
required. Manpages are build and installed during `./waf build` stage
if sphinx-build is present.
Documentation can be build using the following commands:
# Full set of documentation (tutorials + API) in build/docs
./waf docs
# Only tutorials in `build/docs`
./waf sphinx
# Only API docs in `build/docs/doxygen`
./waf doxgyen
Change-Id: I4c08be08ca3e22068db54584f99467aa6cf38d04
Refs: #1462
ndn-cpp-dev is a new implementation of a Named Data Networking client library written in C++.
ndn-cpp-dev is open source under a license described in the file COPYING. While the license does not require it, we really would appreciate it if others would share their contributions to the library if they are willing to do so under the same license.
See the file INSTALL for build and install instructions.
Please submit any bugs or issues to the ndn-cpp-dev issue tracker: http://redmine.named-data.net/projects/ndn-cpp-dev/issues
Additional library tutorials and manpages are available in docs/ folder.
