From 7c598f26a83323a9d7eef2e5f804afc0080d1190 Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Mon, 9 Aug 2021 11:45:01 +0200 Subject: [PATCH] instructions to run linter --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index c52a047..d0d50c4 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ # TMTC Commander EIVE +# Run Linter + +Can be used to quickly check validity of script. Install `flake8` first + +```sh +python3 -m pip install flake8 +``` + +or on Windows + +```sh +py -m pip install flake8 +``` + +and then run the `lint.py` script + +```sh +./lint.py +``` + # Set up virtual environment ## Linux