docs: Adding installation instructions and configuration tips
README.md and INSTALL.md now redirect to documentation in docs/ folder.
Later we will add links to HTML pages with NFD documentation.
Change-Id: I4f02f3166e7802570b24ed225ac4de8c56c6e64e
Refs: #1446
diff --git a/README-dev.md b/README-dev.md
index d9cae4a..aab44e9 100644
--- a/README-dev.md
+++ b/README-dev.md
@@ -1,7 +1,10 @@
-Requirements
----------------------
+Notes for NFD developers
+========================
-Include the following header into all `.hpp` and `.cpp` files:
+Requirements
+------------
+
+Include the following license boilerplate into all `.hpp` and `.cpp` files:
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/**
@@ -36,8 +39,8 @@
Recommendations
---------------
-NFD code is subject to the code style, defined here:
-http://redmine.named-data.net/projects/nfd/wiki/CodeStyle
+NFD code is subject to NFD [code style](http://redmine.named-data.net/projects/nfd/wiki/CodeStyle).
+
Running unit-tests
------------------
@@ -49,27 +52,47 @@
The simplest way to run tests, is just to run the compiled binary without any parameters:
- ./build/unit-tests
+ # Run core tests
+ ./build/unit-tests-core
-However, Boost.Test framework is very flexible and allow a number of
-run-time customization of what tests should be run. For example, it
-is possible to choose to run only specific test suite or only a
-specific test case within a suite:
+ # Run NFD daemon tests
+ ./build/unit-tests-daemon
- # Run only skeleton test suite (see tests/test-skeleton.cpp)
- ./build/unit-tests -t TestSkeleton
+ # Run NFD RIB management tests
+ ./build/unit-tests-rib
- # Run only test cast Test1 from skeleton suite
- ./build/unit-tests -t TestSkeleton/Test1
+However, [Boost.Test framework](http://www.boost.org/doc/libs/1_48_0/libs/test/doc/html/)
+is very flexible and allows a number of run-time customization of what tests should be run.
+For example, it is possible to choose to run only a specific test suite, only a specific
+test case within a suite, or specific test cases within specific test suites:
-By default, Boost.Test framework will produce verbose output only when
-test case fails. If it is desired to see verbose output (result of
-each test assertion), add ``-l all`` option to ``./build/unit-tests``
-command:
+ # Run only TCP Face test suite of NFD daemon tests (see tests/daemon/face/tcp.cpp)
+ ./build/unit-tests-daemon -t FaceTcp
- ./build/unit-tests -l all
+ # Run only test case EndToEnd4 from the same test suite
+ ./build/unit-tests-daemon -t FaceTcp/EndToEnd4
+
+ # Run Basic test case from all core test suites
+ ./build/unit-tests-core -t */Basic
+
+By default, Boost.Test framework will produce verbose output only when a test case fails.
+If it is desired to see verbose output (result of each test assertion), add `-l all`
+option to `./build/unit-tests` command. To see test progress, you can use `-l test_suite`
+or `-p` to show progress bar:
+
+ # Show report all log messages including the passed test notification
+ ./build/unit-tests-daemon -l all
+
+ # Show test suite messages
+ ./build/unit-tests-daemon -l test_suite
+
+ # Show nothing
+ ./build/unit-tests-daemon -l nothing
+
+ # Show progress bar
+ ./build/unit-tests-core -p
There are many more command line options available, information about
-which can be obtained either from the command line using ``--help``
-switch, or online on Boost.Test library website
-(http://www.boost.org/doc/libs/1_48_0/libs/test/doc/html/).
+which can be obtained either from the command line using `--help`
+switch, or online on [Boost.Test library](http://www.boost.org/doc/libs/1_48_0/libs/test/doc/html/)
+website.