From 2a22d70bc6c644733444cc96c01ea96660336de6 Mon Sep 17 00:00:00 2001 From: "Robin.Mueller" <robin.mueller.m@gmail.com> Date: Sat, 4 Apr 2020 16:00:42 +0200 Subject: [PATCH] added coding standard section --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index b9484bc..0169661 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ TMTC Client ==== ## Prerequisites +Runs with Python 3.8. +Don't use Python 2.x! Manual installation of crcmod might be needed 1. Install pip if it is not installed yet 2. Install crcmod and all other reqiored packages: @@ -64,6 +66,11 @@ Implemented. ## Unit Test Some more information will follow on how to write Unit Tests. +## Developers Information +Code Style: [PEP8](https://www.python.org/dev/peps/pep-0008/) +Can be enforced/checked by using Pylint as an external program in PyCharm. +Install it with pip and then install and set-up the Pylint plugin in PyCharm. + ## Import run configurations in PyCharm The PyCharm IDE can be used to comfortably manage a set of run configuations (for example tests for different services). These configurations were shared through the version control system Git -- GitLab