docs: improve README.md
Change-Id: Iba7aea52bb67dd8ee788734e1141ab2459167090
diff --git a/README-dev.md b/README-dev.md
index 0b31401..ad9447c 100644
--- a/README-dev.md
+++ b/README-dev.md
@@ -7,19 +7,18 @@
Code style
----------
-ndn-cxx code is subject to [ndn-cxx code style](http://named-data.net/doc/ndn-cxx/current/code-style.html).
+ndn-cxx code is subject to [ndn-cxx code style](https://named-data.net/doc/ndn-cxx/current/code-style.html).
Licensing
---------
-Contributions to the library must be licensed under LGPL 3.0 or compatible license. If
-you are choosing LGPL 3.0, please use the following license boilerplate in all `.hpp` and
+Contributions to the library must be licensed under the LGPL v3 or compatible license. If
+you are choosing LGPL v3, please use the following license boilerplate in all `.hpp` and
`.cpp` files:
-
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
- * Copyright (c) [Year(s)] [Copyright Holder].
+ * Copyright (c) [Year(s)] [Copyright Holder(s)].
*
* This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
*
@@ -52,7 +51,7 @@
To run the unit tests, ndn-cxx needs to be built with unit test support and installed
into the configured location. For example:
- ./waf configure --with-tests # --debug is also recommended while developing
+ ./waf configure --with-tests # --debug is also strongly recommended while developing
./waf
sudo ./waf install
diff --git a/README.md b/README.md
index ef39232..a04cb68 100644
--- a/README.md
+++ b/README.md
@@ -1,35 +1,40 @@
-ndn-cxx: NDN C++ library with eXperimental eXtensions
-=====================================================
+# ndn-cxx: NDN C++ library with eXperimental eXtensions
+
[](https://travis-ci.org/named-data/ndn-cxx)
+
-ndn-cxx is a C++ library, implementing Named Data Networking (NDN) primitives that can be
-used to implement various NDN applications. The library is currently being used as part of
-the following projects:
+ndn-cxx is a C++14 library, implementing Named Data Networking (NDN) primitives
+that can be used to write various NDN applications. The library is currently
+being used by the following projects:
* [NFD - NDN Forwarding Daemon](https://github.com/named-data/NFD)
* [NLSR - Named-data Link-State Routing protocol](https://github.com/named-data/NLSR)
+* [ndn-tools - Essential NDN command-line tools](https://github.com/named-data/ndn-tools)
* [repo-ng - Next generation of NDN repository](https://github.com/named-data/repo-ng)
-* [ChronoChat - Multi-user NDN chat application](https://github.com/named-data/ChronoChat)
-* [ChronoSync - Sync library for multiuser realtime applications for NDN](https://github.com/named-data/ChronoSync)
-* [ndn-tools - NDN Essential Tools](https://github.com/named-data/ndn-tools)
-* [ndn-traffic-generator - Traffic Generator For NDN](https://github.com/named-data/ndn-traffic-generator)
+* [ChronoSync - Sync library for multiuser realtime applications](https://github.com/named-data/ChronoSync)
+* [PSync - Partial and full synchronization library](https://github.com/named-data/PSync)
+* [ndn-traffic-generator - Traffic generator for NDN](https://github.com/named-data/ndn-traffic-generator)
+* [NAC - Name-based Access Control](https://github.com/named-data/name-based-access-control)
+* [NDNS - Domain Name Service for NDN](https://github.com/named-data/ndns)
-See the file [`docs/INSTALL.rst`](https://github.com/named-data/ndn-cxx/blob/master/docs/INSTALL.rst)
-for build and install instructions.
+## Documentation
-Please submit any bugs or issues to the ndn-cxx issue tracker:
-https://redmine.named-data.net/projects/ndn-cxx/issues
+See [`docs/INSTALL.rst`](docs/INSTALL.rst) for compilation and installation instructions.
-## More documentation
+Extensive documentation is available on the library's [homepage](https://named-data.net/doc/ndn-cxx/).
-Extensive documentation of the library is available on the library's homepage:
-http://www.named-data.net/doc/ndn-cxx/
+## Reporting bugs
-If you are new to the NDN community of software generally, read the
-[Contributor's Guide](https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md).
+Please submit any bugs or feature requests to the
+[ndn-cxx issue tracker](https://redmine.named-data.net/projects/ndn-cxx/issues).
+
+## Contributing
+
+You're encouraged to contribute to ndn-cxx! Check out the
+[Contributor's Guide](https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md) to get started.
## License
-ndn-cxx is an open source project licensed under LGPL 3.0 license. For more information about
-the license, refer to [`COPYING.md`](https://github.com/named-data/ndn-cxx/blob/master/COPYING.md).
+ndn-cxx is an open source project licensed under the LGPL version 3.
+See [`COPYING.md`](COPYING.md) for more information.
diff --git a/docs/README.rst b/docs/README.rst
deleted file mode 100644
index b58f125..0000000
--- a/docs/README.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-ndn-cxx overview
-================
-
-ndn-cxx is a C++ library, implementing Named Data Networking (NDN) primitives that can be
-used to implement various NDN applications. The library is currently being used as part of
-the following projects:
-
-- `NFD - NDN Forwarding Daemon <http://named-data.net/doc/NFD>`__
-- `NLSR - Named-data Link-State Routing
- protocol <https://github.com/named-data/NLSR>`__
-- `repo-ng - Next generation of NDN
- repository <https://github.com/named-data/repo-ng>`__
-- `ChronoChat - Multi-user NDN chat
- application <https://github.com/named-data/ChronoChat>`__
-- `ChronoSync - Sync library for multiuser realtime applications for
- NDN <https://github.com/named-data/ChronoSync>`__
-- `ndn-tools - NDN Essential Tools <https://github.com/named-data/ndn-tools>`__
-- `ndn-traffic-generator - Traffic Generator For
- NDN <https://github.com/named-data/ndn-traffic-generator>`__
-
-Please submit any bugs or issues to the `ndn-cxx issue tracker
-<https://redmine.named-data.net/projects/ndn-cxx/issues>`__.
diff --git a/docs/index.rst b/docs/index.rst
index 8f5dca8..1749fef 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -1,11 +1,22 @@
ndn-cxx: NDN C++ library with eXperimental eXtensions
=====================================================
-ndn-cxx is a C++ library, implementing Named Data Networking (NDN) primitives that can be
-used to implement various NDN applications.
+ndn-cxx is a C++14 library, implementing Named Data Networking (NDN) primitives
+that can be used to write various NDN applications. The library is currently
+being used by the following projects:
-Please submit any bugs or issues to the `ndn-cxx issue tracker
-<https://redmine.named-data.net/projects/ndn-cxx/issues>`__.
+* `NFD - NDN Forwarding Daemon <https://github.com/named-data/NFD>`_
+* `NLSR - Named-data Link-State Routing protocol <https://github.com/named-data/NLSR>`_
+* `ndn-tools - Essential NDN command-line tools <https://github.com/named-data/ndn-tools>`_
+* `repo-ng - Next generation of NDN repository <https://github.com/named-data/repo-ng>`_
+* `ChronoSync - Sync library for multiuser realtime applications <https://github.com/named-data/ChronoSync>`_
+* `PSync - Partial and full synchronization library <https://github.com/named-data/PSync>`_
+* `ndn-traffic-generator - Traffic generator for NDN <https://github.com/named-data/ndn-traffic-generator>`_
+* `NAC - Name-based Access Control <https://github.com/named-data/name-based-access-control>`_
+* `NDNS - Domain Name Service for NDN <https://github.com/named-data/ndns>`_
+
+Please submit any bugs or feature requests to the `ndn-cxx issue tracker
+<https://redmine.named-data.net/projects/ndn-cxx/issues>`_.
ndn-cxx Documentation
---------------------
@@ -14,7 +25,6 @@
:hidden:
:maxdepth: 3
- README
INSTALL
examples
tutorials
@@ -29,15 +39,13 @@
RELEASE_NOTES
releases
-- :doc:`README`
-
- :doc:`INSTALL`
- :doc:`examples`
- :doc:`tutorials`
- + `NDN Software Contributor's Guide <https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md>`__ (guide for newcomers to the NDN community of software generally)
+ + `NDN Software Contributor's Guide <https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md>`_ (guide for newcomers to the NDN community of software generally)
+ :doc:`tutorials/utils-ndn-regex`
+ :doc:`tutorials/security-validator-config`
@@ -64,5 +72,5 @@
License
-------
-ndn-cxx is an open source project licensed under LGPL 3.0 license. For more information about
+ndn-cxx is an open source project licensed under the LGPL version 3. For more information about
the license, refer to `COPYING.md <https://github.com/named-data/ndn-cxx/blob/master/COPYING.md>`_.
diff --git a/docs/release-notes/release-notes-0.1.0.rst b/docs/release-notes/release-notes-0.1.0.rst
index 168f5bc..a8cf1bc 100644
--- a/docs/release-notes/release-notes-0.1.0.rst
+++ b/docs/release-notes/release-notes-0.1.0.rst
@@ -49,11 +49,11 @@
<https://github.com/named-data/NFD>`_
- Full support for `NFD management protocols
- <http://redmine.named-data.net/projects/nfd/wiki/Management>`_ to NFD status
+ <https://redmine.named-data.net/projects/nfd/wiki/Management>`_ to NFD status
information, create and manage NFD Faces, receive NFD Face status change
notifications, update StrategyChoice for namespaces, and manage routes in RIB
- Support for `LocalControlHeader
- <http://redmine.named-data.net/projects/nfd/wiki/LocalControlHeader>`_ to implement
+ <https://redmine.named-data.net/projects/nfd/wiki/LocalControlHeader>`_ to implement
special NDN applications that need low-level control of NDN packet forwarding
- **Security support**
diff --git a/docs/release-notes/release-notes-0.3.3.rst b/docs/release-notes/release-notes-0.3.3.rst
index 65aca00..d7aeecf 100644
--- a/docs/release-notes/release-notes-0.3.3.rst
+++ b/docs/release-notes/release-notes-0.3.3.rst
@@ -117,7 +117,7 @@
Upcoming features (partially finished in development branches):
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-- NDNLPv2 (http://redmine.named-data.net/projects/nfd/wiki/NDNLPv2, :issue:`2520`,
+- NDNLPv2 (https://redmine.named-data.net/projects/nfd/wiki/NDNLPv2, :issue:`2520`,
:issue:`2879`, :issue:`2763`, :issue:`2883`, :issue:`2841`, :issue:`2866`)
- New NDN certificate format (:issue:`2861`, :issue:`2868`)
diff --git a/docs/releases.rst b/docs/releases.rst
index 7312919..45d9377 100644
--- a/docs/releases.rst
+++ b/docs/releases.rst
@@ -1,5 +1,5 @@
-ndn-cxx Versions
-++++++++++++++++
+All ndn-cxx Releases
+++++++++++++++++++++
.. toctree::
:hidden:
@@ -28,6 +28,8 @@
`src (git) <https://github.com/named-data/ndn-cxx/releases/tag/ndn-cxx-0.6.5>`__,
`src (tarball) <https://named-data.net/downloads/nfd-0.6.5.tar.bz2>`__ (`checksum <https://named-data.net/downloads/nfd-0.6.5.tar.bz2.sha256>`__)
+* **ndn-cxx version 0.6.4 was skipped**
+
* **ndn-cxx version 0.6.3**
(:doc:`Release Notes <release-notes/release-notes-0.6.3>`, `Documentation <https://named-data.net/doc/ndn-cxx/0.6.3/>`__)