diff --git a/README.md b/README.md index d6cc47cce2eed46101a1c9209306f820c6cbca67..84fcd932963da75a7fb35ad74f044919ac072deb 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,22 @@ TMTC Client ## Prerequisites Runs with Python 3.8. Don't use Python 2.x! -Manual installation of crcmod and pyserial might be needed - 1. Install pip if it is not installed yet - 2. Install crcmod and all other required packages: - Command: python<version> -m pip<version> install crcmod - or use IDE (interpreter settings -> pip in PyCharm) +Manual installation of crcmod and pyserial might be needed. +It is recommended to install use PyCharm to run this client. +Students of the Uni Stuttgart usually have access to PyCharm Professional. +1. Install pip if it is not installed yet +2. Install crcmod and all other required packages if using system python + compiler. If using the local venv as the compiler, these packages + should be installed. <br> + Command: + ```sh + python<version> -m pip<version> install crcmod + ``` + or use IDE (interpreter settings -> pip in PyCharm) +3. Install python-tk. + ```sh + sudo apt-get install python-tk + ``` ## How To Use The script can be used by specifying command line parameters.