Improve documentation add valid test result.

ThunderFly-aerospace · Feb 8, 2024 · ec686e5 · ec686e5
1 parent 7887849
commit ec686e5
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/doc/img/test_passed.png b/doc/img/test_passed.png
diff --git a/sw/README.md b/sw/README.md
@@ -20,25 +20,24 @@ cd pymlab_interactive
 python3 quality_check.py --port 9 --address 0x50 --req_freq 489 --max_deviation 10
 ```
 
-## Prerequirements 
+## Prerequirements
 * python3
 * [pymlab](https://github.com/MLAB-project/pymlab) with installed I2C drivers e.g. smbus2
 * [beepy](https://pypi.org/project/beepy/)
 * curses
-* argparse 
+* argparse
 
 
-## Usage: 
+## Usage:
 
 ```
 python3 quality_check.py --port 7 --address 0x50 --req_freq 1000 --max_deviation 500
 ```
 
-`--port` smbus port 
+`--port` smbus port
 `--address` I2C address of TFRPM counter
-`--req_freq` 
+`--req_freq`
 `--max_deviation`
 
 ## Screenshots
-![obrazek](https://github.com/ThunderFly-aerospace/TFRPM01/assets/5196729/f1046602-cf83-4bb0-9f1a-cd9a75cdab36)
-
+![Valid test](/doc/img/test_passed.png)