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

Update the README

Browse Source
This commit is contained in:
Wojciech Kozlowski 2019-04-07 00:21:25 +02:00
parent d8b729caac
commit 91bfae0126
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -80,11 +80,10 @@ Adding a new topology is straightforward.
4. Create a `staticd` directory and populate it with configuration files for 4. Create a `staticd` directory and populate it with configuration files for
the `staticd` daemon to configure the default routes on hosts. the `staticd` daemon to configure the default routes on hosts.
5. Create a `README.md` file to describe your topology. 5. Create a `README.md` file to describe your topology.
6. Add your topology to the `route-0.py` file. By default a topology will
support the `plain` and `basic` scenarios.
The easiest way to start would be to copy some other topology and customise it The easiest way to start would be to copy some other topology and customise it
as appropriate. 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 ### Adding a new scenario
@ -99,6 +98,9 @@ additional scenarios is also pretty straightforward.
run. You don't need to do this for `zebra` or `staticd` unless you want to run. You don't need to do this for `zebra` or `staticd` unless you want to
override the topology defaults. override the topology defaults.
Just like with the topology, the main script should automatically pick up the
new scenario.
## Name ## Name
I am terrible at coming up with names so I'll at least explain myself. The I am terrible at coming up with names so I'll at least explain myself. The