aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFranklin Wei <me@fwei.tk>2018-08-03 18:54:30 +0000
committerFranklin Wei <me@fwei.tk>2018-08-03 18:54:30 +0000
commit633945d717933844b7819fae37f936f4e5c9d32f (patch)
tree1a2a076bbe3652213cc23ef3943590b037ecd8c6
parent15c809cc72125c149a56eaaa67b6fd546e2302ae (diff)
downloadcsaa-633945d717933844b7819fae37f936f4e5c9d32f.zip
csaa-633945d717933844b7819fae37f936f4e5c9d32f.tar.gz
csaa-633945d717933844b7819fae37f936f4e5c9d32f.tar.bz2
csaa-633945d717933844b7819fae37f936f4e5c9d32f.tar.xz
Update README.md
-rw-r--r--README.md25
1 files changed, 14 insertions, 11 deletions
diff --git a/README.md b/README.md
index 2beb900..c0e2dc4 100644
--- a/README.md
+++ b/README.md
@@ -52,20 +52,20 @@ Edit `service_provider.c` and `dummy_service.c` to uncomment the
```
This should populate the `databases` directory with prepopulated
-databases and module states.
+databases and module states. This step only needs to be done once; the
+generated databases can be re-used as needed.
#### Running Tests
-Edit `testmain_preinit.sh` to specify the desired logleaves range and
-number of trials.
-
-Then run:
+Run `testmain_preinit.sh` with the desired logleaves range and number
+of trials as its command-line arguments. For example, the following
+will run logleaves 10-25 with 5 trials for each logleaves value:
```
-./testmain_preinit.sh
+./testmain_preinit.sh 10 25 5
```
-This will produce results in the `results` directory.
+This script will produce results in the `results` directory.
#### Producing Graphs
@@ -73,15 +73,18 @@ Run:
```
cd results
-../tabulate.sh
+../tabulate.sh 10 25 5
```
Your working directory must be in the `results` directory for this to
-work. This will produce many files with the prefix `final_` in the
+work. The arguments to `tabulate.sh` must be exactly the same as those
+passed to `testmain_preinit.sh`.
+
+This step will produce many files with the prefix `final_` in the
`results` directory.
-To use GnuPlot to produce graphs from these, change to the project
-root directory, and run:
+To use Gnuplot to produce graphs from these, change to the project
+root directory and run:
```
./genlabels.sh