Skip to content

Commit

Permalink
Fix warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
petya2164 committed Oct 25, 2018
1 parent b9dc448 commit d53ce72
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 46 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ Now you can expand your custom simulation as you like. If you use additional
ns-3 modules, then you need to add them in the wscript (most likely, you will
get a build error if you are missing a module).

If your simulation has multiple source files (*.cc files), then you can add
If your simulation has multiple source files (.cc files), then you can add
these in the wscript like this::

obj.source = ['my-simulation.cc', 'source2.cc', 'source3.cc']
Expand Down
54 changes: 9 additions & 45 deletions docs/before_you_start.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,13 @@ Before You Start

The project description, licensing, source code and how to compile
are available `here <https://github.com/steinwurf/kodo-ns3-examples>`_.
**Once you have built the project**, you can follow this tutorial.
Otherwise, please be sure to have the project up and running first.
**Once you have compiled the project**, you can follow this tutorial.

Overview
--------

Currently the repository ``kodo-ns3-examples`` contains 3 basic examples
in its main path regarding how to use the library with ns-3, namely:
Currently the ``kodo-ns3-examples`` repository contains the following
basic examples:

* ``kodo-wifi-broadcast``: This example consists on broadcasting packets
with RLNC from a transmitter to N receivers with an IEEE 802.11b WiFi
Expand All @@ -24,17 +23,6 @@ in its main path regarding how to use the library with ns-3, namely:
a decoder with different erasure rates. Recoding can be set on or off and
erasure rates modified by command-line parsing.

Automated Builds
----------------

You can check the build status of the repository master branch on our
`buildbot <http://buildbot.steinwurf.dk/stats?projects=kodo-ns3-examples>`_
page. Our buildbot displays the supported combinations of platforms,
operating systems, and compilers. At the link, you can check
build status and build statistics for them in the respective waterfall link.
This information is provided also for other Steinwurf projects such as Kodo
itself.

What You Should Know Before the Tutorial
----------------------------------------

Expand All @@ -46,47 +34,23 @@ recommended. If you are also a C++ beginner, you can refer to this
`tutorial <http://www.cplusplus.com/doc/tutorial/>`_ as a guide from the basics
to more advanced features of the language. Given that both ns-3 and Kodo are
highly object-oriented projects, we strongly recommend you to spend some
time on class related topics, particularly object properties (polymorphism,
time on class-related topics, particularly object properties (polymorphism,
inheritance) and templates (generic classes or functions based on abstract
types). In the mentioned C++ tutorial you may find plenty examples for this.

types). In the mentioned C++ tutorial you can find plenty of examples.

Kodo
^^^^

Kodo is a C++ library from `Steinwurf <http://www.steinwurf.com>`_ that
implements Random Linear Network Coding and its variants, but also other
codes like Reed-Solomon. The links you should review first to get a
clear idea of what the library does, are:

* `Kodo documentation <http://docs.steinwurf.com/>`_
* `Kodo source code <https://github.com/steinwurf/kodo>`_

codes like Reed-Solomon. You can read more about Kodo at:
http://docs.steinwurf.com

Kodo C++ bindings
^^^^^^^^^^^^^^^^^

To ease the development process, we use C++
`bindings <https://github.com/steinwurf/kodo-cpp>`_ that are high level
wrappers of the basic core application programming interfaces of Kodo.
Besides making the process easier, the bindings provide encapsulation
and abstraction from the library. If you want to get more details, please
refer to the previous link. There you will find documentation and examples
regading on how to use the bindings on their own.

ns-3
^^^^

`ns-3 <http://www.nsnam.org/>`_ is a network simulator of the OSI layers
written in C++ for research and educational purposes under the GPLv2 license.
You can find documentation regarding a tutorial, a manual and a model
description in this `link <http://www.nsnam.org/documentation/>`_.

Waf
^^^

Our main building tool is ``waf`` in the same way it is for ns-3. So, if you
have used ns-3 before this should be transparent to you. If you have not used
``waf`` , you can review a description of the tool with some examples in the
`waf project <https://waf.io/>`_. For this reason, we highly recommend you to follow the
instructions in the repository link mentioned at the beginning of this document.
You can find documentation including a tutorial, a manual and a model
description here: http://www.nsnam.org/documentation

0 comments on commit d53ce72

Please sign in to comment.