docs: fix numerous references and formatting issues
Change-Id: I2be0a3a49e1dd11a74324d925b1c9f7fcde7f29b
diff --git a/docs/install.rst b/docs/install.rst
index 5557d1c..29f92b2 100644
--- a/docs/install.rst
+++ b/docs/install.rst
@@ -18,7 +18,9 @@
------------
You can use the latest image from `GitHub Container Registry
-<https://github.com/named-data/mini-ndn/pkgs/container/mini-ndn>`__::
+<https://github.com/named-data/mini-ndn/pkgs/container/mini-ndn>`__:
+
+.. code-block:: sh
docker run -it --cpus=4 --memory=4g --privileged \
-v /lib/modules:/lib/modules \
@@ -29,11 +31,15 @@
The provided Dockerfile can be used to build an image from scratch. To build with the Dockerfile:
- - Clone the repository and type::
+- Clone the repository and type:
+
+ .. code-block:: sh
docker build -t minindn .
- - You can then access the container through shell with::
+- You can then access the container through shell with:
+
+ .. code-block:: sh
docker run -it --cpus=4 --memory=4g --privileged \
-v /lib/modules:/lib/modules \
@@ -73,7 +79,7 @@
To install Mini-NDN and its dependencies, clone this repository and run:
-::
+.. code-block:: sh
./install.sh
@@ -94,7 +100,7 @@
You can see all command line flags by running:
-::
+.. code-block:: sh
./install.sh -h
@@ -118,20 +124,20 @@
Mini-NDN is based on Mininet. To install Mininet:
-::
+.. code-block:: sh
git clone --depth 1 https://github.com/mininet/mininet.git
After Mininet source is on your system, run the following command to
install Mininet core dependencies and Open vSwitch:
-::
+.. code-block:: sh
./util/install.sh -nv
To check if Mininet is working correctly, run this test:
-::
+.. code-block:: sh
sudo mn --test pingall
@@ -185,7 +191,7 @@
Infoedit is used to edit configuration files for NFD and NLSR.
To install infoedit:
-::
+.. code-block:: sh
git clone --depth 1 https://github.com/NDN-Routing/infoedit
cd infoedit
@@ -198,7 +204,7 @@
You can execute the following example to bring up the Mini-NDN command line
with NFD and NLSR running on each node:
-::
+.. code-block:: sh
sudo python examples/mnndn.py
@@ -224,17 +230,16 @@
You can install the most recent release using:
-::
+.. code-block:: sh
./install.sh --source --release=current
You can also select a specified release using:
-::
+.. code-block:: sh
./install.sh --source --release=[chosen version]
-
Currently, the compatible versions include:
- ``2024-08``: ndn-cxx 0.9.0, NFD 24.07, NLSR 24.08, PSync 0.5.0,