aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md31
1 files changed, 15 insertions, 16 deletions
diff --git a/README.md b/README.md
index c8697f5..d6e0839 100644
--- a/README.md
+++ b/README.md
@@ -10,31 +10,30 @@ a look at the examples/ folder.
## Workflow, both external and internal:
- 1. user defines the network graph, creating instances of model.Node
+ 1. User defines the network graph, creating instances of model.Node
and model.DIF classes
- 2. user creates an instance of a Testbed class
+ 2. User creates an instance of a Testbed class
- 3. user creates an instance of prototype.Experiment class, passing
- the testbed instance and a list of Node instances
+ 3. User creates an instance of prototype.Experiment class, passing
+ the testbed instance and a list of Node instances
- * At the end of the base Experiment constructor, the
- generate function is called to generate information about
- per-node IPCPs, registrations and enrollment, ready to be
- used by the plugins
+ 1. At the end of the base Experiment constructor, the
+ generate function is called to generate information about
+ per-node IPCPs, registrations and enrollment, ready to be
+ used by the plugins
- 4. user calls run() on the prototype.Experiment instance:
+ 4. User calls run() on the prototype.Experiment instance:
- * First, run() calls Testbed.swap_in(), passing the
- Experiment, and filling in the missing information
+ 1. run() calls Testbed.swap_in(), passing the Experiment, and
+ filling in the missing information
- * Second, run() calls a prototype-specific setup function,
- to create the required IPCPs, perform registrations,
- enrollments, etc.
+ 2. run() calls a prototype-specific setup function, to create the
+ required IPCPs, perform registrations, enrollments, etc.
- * Third, perform tests (TODO)
+ 3. Perform tests (TODO)
- * Fourth, run() calls Testbed.swap_out()
+ 4. run() calls Testbed.swap_out()
## Installation