From dcbfde82a5c30ef2a848ffd1f801dd71ba0cc9f8 Mon Sep 17 00:00:00 2001 From: DeflateAwning <11021263+DeflateAwning@users.noreply.github.com> Date: Tue, 8 Oct 2024 15:23:44 +0200 Subject: [PATCH] Fix setup instructions --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8e4819d..67d1e9e 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Over time, the goal is to develop it into the ground station control software. 2. Clone this repo, and open a terminal in this repo's root. 3. Run `python3.11 -m venv venv/` to create a Python virtual environment named `venv/` in the current directory. 4. Run `.\venv\bin\activate` (on Windows), or `source ./venv/bin/activate` (on real operating systems). -5. Run `pip install -e cts1_ground_support[dev]` to install this Python Project in your virtual environment. +5. Run `pip install -e .` to install this Python Project in your virtual environment. 6. Run `cts1_ground_support --help` to ensure it installed. 7. Run `cts1_ground_support` to start the ground support terminal. 8. Visit [http://127.0.0.1:8050/](http://127.0.0.1:8050/) in a web browser to view the web interface and send commands to your dev kit. @@ -38,7 +38,7 @@ Over time, the goal is to develop it into the ground station control software. ## Development 1. Install the project as in the Getting Started section. -2. Run `pip install -e cts1_ground_support[dev]` to install the development dependencies. -3. Run `cts1_ground_support --debug` to start the ground support terminal in debug mode. +2. Run `pip install -e '.[dev]'` to install the development dependencies. +3. Optional: Run `cts1_ground_support --debug` to start the ground support terminal in debug mode. The ground support terminal will automatically reload when you make changes to the code. It is written using the Dash framework in Python.