diff --git a/README.md b/README.md index 1d98563..876c32e 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,19 @@ # N-Back Sequence Generator with [Hidden] Markov Chain -# Compile and Build +*Note:* All the following commands can be run inside `sbt` shell. For the sake of simplicity, it is assumed the developer is in her Terminal when running the commands. + + +## Compile and Build To build code and compile use `sbt compile` and `sbt build`. It's recommended to use `sbt clean` before any of them :-). -# Run +## Run -To run default generator with random sequence generator and some other benchmarking use the following command: +To run default generator (with random sequence generator), and some other benchmarking and reporting outputs use the following command: `sbt run` -# Benchmark +## Benchmark `sbt testOnly `