Mercurial > repos > pointsource_algs / file diff

--- a/README.md	Fri Dec 02 18:14:03 2022 +0200
+++ b/README.md	Fri Dec 02 21:20:04 2022 +0200
@@ -54,11 +54,14 @@
 
 To compile the code and run the experiments in the manuscript, use
 ```console
-cargo run --release
+cargo run --release -- -o results
 ```
 When doing this for the first time, several dependencies will be downloaded.
-The `--release` flag is required to build optimised high performance code.
-Without that flag the performance will be significantly worse.
+The double-dash (`--`) separates the arguments of Cargo and this software,
+`pointsource_algs`. The `--release` option to Cargo is required for `rustc` to
+build optimised high performance code. Without that flag the performance will
+be significantly worse. The `-o results` option tells `pointsource_algs` to
+write results in the `results` directory. The option is required.
 
 Alternatively, you may build the executable with
 ```console
@@ -66,14 +69,15 @@
 ```
 and then run it with
 ```
-target/release/pointsource_algs
+target/release/pointsource_algs -o results
 ```
 
 ### Documentation
 
-Use the `--help` option to get an extensive listing of command line options.
-If using `cargo` to run the executable, you have to pass any arguments to this
-program after a double-dash:
+Use the `--help` option to get an extensive listing of command line options to
+customise algorithm parameters and the experiments performed. As above with
+`-o`, if using `cargo` to run the executable, you have to pass any arguments
+to `pointsource_algs` after a double-dash:
 ```console
 cargo run --release -- --help
 ```