github-mirror/route0
1
0
Fork 0
mirror of https://github.com/Wojtek242/route0.git synced 2024-11-22 07:05:25 +01:00
Code Issues Packages Projects Releases Wiki Activity

Remove CONTRIBUTING section from README

Browse Source
This commit is contained in:
Wojciech Kozlowski 2019-04-07 01:31:58 +02:00
parent b4b1e342ca
commit a71cf2b6f3
1 changed files with 1 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
README.md
View File

@ -183,43 +183,7 @@ one topology, but using different terminology avoids confusion.
## Contributing
There are many ways to contribute to Route 0. If you are an expert in
networking, you can look for and correct errors, improve the existing lessons,
add new lessons, or add IPv6 support. Another way to contribute is to simply
add new scenarios or topologies that you feel would be interesting for others.
### Adding a new topology
Adding a new topology is straightforward.
1. Create a new directory in the `topology` directory.
2. Create a `topo.py` file and define a class `NetTopo` that inherits from
`mininet.topo.Topo` and build your new topology in its constructor.
3. Create a `zebra` directory and populate it with configuration files for the
`zebra` daemon to configure the interfaces in your topology.
4. Create a `staticd` directory and populate it with configuration files for
the `staticd` daemon to configure the default routes on hosts.
5. Create a `README.md` file to describe your topology.
The easiest way to start would be to copy some other topology and customise it
as appropriate. Once ready, the topology should be automatically detected by
`route-0.py` when you pass your topology's name as the `--topology` argument.
### Adding a new scenario
By default all topologies support the `plain` and `basic` scenarios. Adding a
additional scenarios is also pretty straightforward.
1. In the topology's directory, make sure there is a `scenario` directory.
Create one if it doesn't exist.
2. In the `scenario` directory create a new directory for your specific
scenario.
3. In your new directory create one directory for each daemon you intend to
run. You don't need to do this for `zebra` or `staticd` unless you want to
override the topology defaults.
Just like with the topology, the main script should automatically pick up the
new scenario.
For information on how to contribute see [CONTRIBUTING](CONTRIBUTING.md).
## Name