diff --git a/API/README.md b/API/README.md index 9c18c0d..0373d44 100644 --- a/API/README.md +++ b/API/README.md @@ -76,3 +76,13 @@ The script will host a `waitress` webserver on port `8080` of the machine it's r - y: int - w: int - h: int + +## Flags and Arguments + +You may need to specify all kinds of different flags or arguments to run the matrix correctly. For usage, please refer to any of the scripts, followed by the flag `--help`. + +### Example: + +```bash +sudo python main.py --led-rows=64 --led-cols=64 --led-slowdown-gpio=5 --led-parallel=3 --led-chain=3 --led-gpio-mapping=regular +```