From b464182df771f4b01871cbedfa89f296ff2655cc Mon Sep 17 00:00:00 2001 From: Robin Mueller Date: Thu, 14 Sep 2023 12:18:21 +0200 Subject: [PATCH] README --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 2f358f5..5a6176b 100644 --- a/README.md +++ b/README.md @@ -61,22 +61,30 @@ Run GUI mode # Install requirements There are two ways to install the requirements. One is to install the primary dependency -`tmtccmd` interactively. This is the recommended way +`tmtccmd` interactively. + +## Installing via PyPI Assuming you are running in a virtual environment: -1. Install `tmtccmd` for virtual environment. `-e` for interactive installation. +```sh +pip install -e . +``` - ```sh - cd deps/tmtccmd - pip install -e .[gui] - ``` +## Install interactively -Alternatively you can also install the packages from PyPI completely, but the risk of -incompatibilities will be high there +Clone the dependency first inside the `deps` folder ```sh -pip install -r requirements.txt +cd deps +./install_tmtccmd.sh +``` + +Then you can install `tmtccmd` interactively + +```sh +cd tmtccmd +pip install -e . ``` # Run Linter