docs: Add release notes and final documentation corrections
Change-Id: Ic8010b536c36d84e26f4d9ea6384f81e869e1407
diff --git a/NFD/README.md b/NFD/README.md
index 519be3f..40af61e 100644
--- a/NFD/README.md
+++ b/NFD/README.md
@@ -10,3 +10,20 @@
There are several ndnSIM-specific changes to NFD codebase and manual conflict resolution
may be required.
+
+Changes in NFD codebase
+-----------------------
+
+The following commits introduced changes to NFD codebase:
+
+- `e98f2e8` NFD: Removing parts irrelevant for the simulator
+- `7245d5d` NFD: Adding readme and auto-generated headers
+- `dc88971` NFD: Disabling all "standard" face types in Face manager
+- `0fb253e` NFD: Enable metric parameter on a face
+- `1de5da6` NFD: Redirecting nfd::scheduler to ns3::Simulator and getting rid of GlobalIo
+- `dbc7794` NFD: Replace NFD logger with NS3 logging facility
+- `de1f773` NFD: Keep both the CS of NFD and ndnSIM
+- `542a623` NFD: Extending ConfigFile to support passing of a parsed ConfigSection instead of
+ raw config file
+- `9bcf39e` NFD: Extend forwarding pipelines with beforeSatisfyInterest and
+ beforeExpirePendingInterest signals
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
new file mode 100644
index 0000000..d707391
--- /dev/null
+++ b/RELEASE_NOTES.md
@@ -0,0 +1,77 @@
+ndnSIM Release Notes
+====================
+
+This file contains ndnSIM release notes.
+
+All of the ndnSIM documentation is accessible from the [ndnSIM website](http://ndnsim.net).
+
+Release 2.0
+-----------
+
+### Overview
+
+ndnSIM 2.0 is a new release of NS-3 based Named Data Networking (NDN) simulator that went
+through extensive refactoring and rewriting. The key new features of the new version:
+
+- ndnSIM no longer re-implements basic NDN primitives and directly uses implementation from
+ [ndn-cxx library (NDN C++ library with eXperimental eXtensions)](http://named-data.net/doc/ndn-cxx/).
+
+- All NDN forwarding and management is implemented directly using source code of
+ [Named Data Networking Forwarding Daemon (NFD)](http://named-data.net/doc/NFD/). The
+ current code is based on `a22a2172611b1cb93b2e2f53d9d5da122b384f3e` commit of
+ [NFD repository](https://github.com/named-data/NFD/tree/a22a2172611b1cb93b2e2f53d9d5da122b384f3e).
+
+ Note RIB Manager is not yet available in ndnSIM.
+
+* Packet format changed to the [NDN packet format](http://named-data.net/doc/ndn-tlv/).
+
+* Code style changes to conform to
+ [ndn-cxx Code Style and Coding Guidelines](http://named-data.net/doc/ndn-cxx/current/code-style.html)
+ This change also includes renaming of the header and source files: `*.h` -> `*.hpp`, `*.cc` -> `*.cpp`
+
+* ndnSIM now uses C++11.
+
+### New Features
+
+- Integration with NFD codebase:
+ - A realistic behavior is added to the simulations.
+ - Forwarding plane extensions can be used in both ndnSIM simulations and real NFD deployment.
+- Per namespace forwarding strategies for different namespaces (one strategy per namespace).
+- New examples:
+ * `ndn-load-balancer`
+ * `ndn-grid-multiple-strategies`
+ * `ndn-different-strategy-per-prefix`
+ * Basic examples using python bindings: `ndn-simple.py` and `ndn-grid.py`
+- Use of the the full-featured NDN packet format.
+- Full-featured support for Interest selectors.
+- Full-featured crypto operations can be simulated (disabled by default).
+- FibHelper to manage FIB entries.
+- StrategyChoiceHelper to manage per-namespace forwarding strategy selection.
+
+### Changes
+
+- HopCount tracing now includes only one way network-level hop count (e.g., the number of
+ physical links traversed by a packet). Previously, this tracing was round-trip and included
+ applications hops.
+- Python bindings have changed and, due to limitations of pybindgen, currently cover a smaller
+ subset of C++ code
+ ([Task #2341](http://redmine.named-data.net/issues/2341)).
+- LinkControlHelper now uses ErrorRate to simulate link failure/recovery. Previously it was
+ relying on Up/Down flag on NDN level.
+- The Face abstraction of NFD is now used.
+
+### Bug fixes
+
+- Fix processing files with customized LossRate or Queue model in AnnotatedTopologyReader
+ [Bug #2354](http://redmine.named-data.net/issues/2354).
+
+### Removals
+
+- PyNDN emulation
+- (temporarily) ApiFace. Will be replaced with emulation of ndn-cxx `ndn::Face` in future releases
+ ([Issue #2370](http://redmine.named-data.net/issues/2370)).
+- (temporarily) UdpFace, TcpFace
+ ([Issue #2371](http://redmine.named-data.net/issues/2371)).
+- Limits, LimitsWindow, LimitsRate.
+- PIT, FIB with "replacement" policies.
+- Old deprecated packet formats.
diff --git a/VERSION b/VERSION
index 854f6d0..227cea2 100644
--- a/VERSION
+++ b/VERSION
@@ -1 +1 @@
-ndnSIM version 0.2.8
+2.0.0
diff --git a/docs/source/_templates/indexcontent.html b/docs/source/_templates/indexcontent.html
index d25b177..4b07a6e 100644
--- a/docs/source/_templates/indexcontent.html
+++ b/docs/source/_templates/indexcontent.html
@@ -10,7 +10,7 @@
<li>ndnSIM no longer re-implements basic NDN primitives and directly uses implementation from <a class="reference external" href="http://named-data.net/doc/ndn-cxx/">ndn-cxx library (NDN C++ library with eXperimental eXtensions)</a>.</li>
<li>All NDN forwarding and management is implemented directly using source code of <a class="reference external" href="http://named-data.net/doc/NFD/">Named
Data Networking Forwarding Daemon (NFD)</a></li>
-<li>Packet format changed to <a class="reference external" href="http://named-data.net/doc/ndn-tlv/">NDN-TLV</a></li>
+<li>Packet format changed to the <a class="reference external" href="http://named-data.net/doc/ndn-tlv/">NDN packet format</a></li>
</ul>
<p>
diff --git a/docs/source/intro.rst b/docs/source/intro.rst
index c152ad4..de72e7d 100644
--- a/docs/source/intro.rst
+++ b/docs/source/intro.rst
@@ -19,7 +19,7 @@
<http://named-data.net/doc/ndn-cxx/>`_.
- All NDN forwarding and management is implemented directly using source code of `Named
Data Networking Forwarding Daemon (NFD) <http://named-data.net/doc/NFD/>`_
-- Packet format changed to `NDN-TLV <http://named-data.net/doc/ndn-tlv/>`_
+- Packet format changed to the `NDN packet format <http://named-data.net/doc/ndn-tlv/>`_
.. note::
Please note that ndnSIM 2.0 has major refactoring and simulation scenario written for