improve readme

stefantds · Jan 26, 2022 · 1f6f5a5 · 1f6f5a5
1 parent 98f5b56
commit 1f6f5a5
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -105,28 +105,45 @@ go test ./epi/nonuniform_random_number -timeout 30s
 
 In order to track the progress, a CLI tool is included in this repository. The original EPI Judge has a similar tool (but presented as a HTML page).
 
+```
+Usage: ./progress [options] [chapter_nb ...]
+
+Options:
+  -d string
+        path to epi folder. (default "./epi")
+  -v    show detailed test status.
+```
+
+### Examples
+
 See progress aggregated per chapter (for all chapters):
 
 ```sh
 go run ./progress
 ```
 
+![cli result](docs/progress_all.png)
+
 See progress aggregated per chapter (for selected chapters):
 
 ```sh
-go run ./progress 7 8
+go run ./progress 8 10
 ```
 
-See progress with details (for all chapters):
+![cli result](docs/progress_8_10.png)
+
+See progress with details (for selected chapters):
 
 ```sh
-go run ./progress -v
+go run ./progress -v 7 8
 ```
 
-See progress with details (for selected chapters):
+![cli result](docs/progress_8_10_v.png)
+
+See progress with details (for all chapters):
 
 ```sh
-go run ./progress -v 7 8
+go run ./progress -v
 ```
 
 Note that running the commands from a different repository requires to additionally pass the path to the `epi` folder as a parameter.

diff --git a/docs/progress_8_10.png b/docs/progress_8_10.png
diff --git a/docs/progress_8_10_v.png b/docs/progress_8_10_v.png
diff --git a/docs/progress_all.png b/docs/progress_all.png