Commit dc1c04f2 authored by Simon Redman's avatar Simon Redman

Add README documentation for

parent f8943191
......@@ -16,6 +16,7 @@ You are now set up!
These instructions will be updated as the code is actually written
Before you will be able to run any commands, activate the virtual environment by running `source env/bin/activate`
#### 1.
This is both a program which can be run on its own, mostly for testing purposes, and a library which is used by the following programs to parse emulab's topology into [NetJSON]( NetworkGraph for usage with the NetworkX network graph library.
......@@ -25,6 +26,9 @@ The topology is parsed using the information in `/var/emulab/boot/topomap` to ge
For description of the non-standard fields used, see the NetworkGraph section of this document
#### 2.
This is an executable library which has a single method: `add_quagga_user_to_network`, which SSHes to every requested host and adds a user named `quagga`. It might make sense to obsolete this script by baking the quagga user into the Emulab image.
Once this codebase is finished, this section should go away. But great works are never finished, merely abandoned.
Markdown is supported
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment