diff options
| author | Rafael Zalamena <rzalamena@opensourcerouting.org> | 2017-11-09 20:35:01 +0100 |
|---|---|---|
| committer | Donald Sharp <sharpd@cumulusnetworks.com> | 2018-11-28 02:22:12 +0100 |
| commit | 28a9b4f56e565d711088c85edb72b04fb2828ca6 (patch) | |
| tree | 234968b6a34e456e6362979e384aa7240aa6bf24 /tests/topotests/README.md | |
| parent | topotest/topogen: demote some messages level (diff) | |
| download | frr-28a9b4f56e565d711088c85edb72b04fb2828ca6.tar.xz frr-28a9b4f56e565d711088c85edb72b04fb2828ca6.zip | |
doc: update README and add code snippets
Add some pointers in the README documentation that might help users get
ready to use topotest.
Diffstat (limited to 'tests/topotests/README.md')
| -rw-r--r-- | tests/topotests/README.md | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/tests/topotests/README.md b/tests/topotests/README.md index 3176c9ef9..823f5d72b 100644 --- a/tests/topotests/README.md +++ b/tests/topotests/README.md @@ -1,5 +1,17 @@ # FRRouting Topology Tests with Mininet +## Guidelines + +Instructions for use, write or debug topologies can be found in the +[guidelines](GUIDELINES.md). To learn/remember common code snippets see +[here](SNIPPETS.md). + +Before creating a new topology, make sure that there isn't one already +that does what you need. If nothing is similar, then you may create a +new topology, preferably, using the newest +[template](example-test/test_template.py). + + ## Installation of Mininet for running tests Only tested with Ubuntu 16.04 (which uses Mininet 2.2.0) |