@@ -45,6 +45,7 @@ The `Install MiniCPS`_ section provides instructions to install ``minicps``
4545for a user or a developer, and it assumes that you *already * have installed
4646``mininet ``.
4747
48+
4849.. INSTALL MINICPS {{{3
4950
5051 Install MiniCPS
@@ -56,6 +57,23 @@ MiniCPS is can be installed using ``pip``:
5657
5758 sudo pip install minicps
5859
60+ Test the installation downloading one of our examples from
61+ https://github.com/scy-phy/minicps/tree/master/examples and try to run it.
62+
63+ For example, given that you downloaded the ``examples `` directory,
64+ then you can ``cd swat-s1 `` folder and run:
65+
66+ .. code-block :: console
67+
68+ sudo python run.py
69+
70+
71+ .. INSTALL OPTIONAL {{{3
72+ .. _install-optional :
73+
74+ Install Optional Packages
75+ -------------------------
76+
5977
6078For *SDN controller development * there are many options,
6179``pox `` is a good starting point and Mininet's VM already includes it. If you
@@ -80,16 +98,7 @@ Notice that:
8098* ``POX_PATH `` defaults to ``~/pox `` and ``MINICPS_PATH `` defaults to
8199 ``~/minicps ``, indeed ``~/minicps/bin/init `` should work for you.
82100
83- .. INSTALL OPTIONAL {{{3
84- .. _install-optional :
85-
86-
87- Test the installation with:
88-
89- .. code-block :: console
90101
91- cd ~/minicps
92- make tests
93102
94103
95104If you want to contribute to the project please take a look at
@@ -119,8 +128,7 @@ using the ``-Y`` option:
119128
120129.. code-block :: console
121130
122- ssh -Y mininet@minnetvm
123-
131+ ssh -Y mininet@mininetvm
124132
125133.. IPv6 {{{3
126134
@@ -156,32 +164,3 @@ Instruction taken from
156164`here <https://github.com/mininet/mininet/issues/454 >`_
157165
158166
159- .. OFFILNE DOCUMENTATION {{{3
160-
161- Offline Documentation
162- ---------------------
163-
164- First install packages listed in `Install optional dependencies `_.
165-
166- Then open ``docs/Makefile `` and check that ``SPHINXBUILD `` reference to
167- ``sphinx-build `` command. (e.g., Arch Linux users can use ``sphinx-build2 ``)
168-
169- Then to build the doc in ``html `` format type:
170-
171- .. code-block :: console
172-
173- cd docs
174- make html
175-
176- Then to navigate a static version through a browser (e.g., ``firefox ``) type:
177-
178- .. code-block :: console
179-
180- firefox _build/html/index.html
181-
182-
183- .. LOGGING AND TESTING {{{2
184-
185- .. Logging and Testing
186- .. ====================
187- .. TODO
0 commit comments