From aa71d9993fa3325861304e1d50f6339441e6dbcc Mon Sep 17 00:00:00 2001 From: Robert Honz Date: Thu, 27 Mar 2025 18:57:34 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Readme=20and=20Makefile=20have=20be?= =?UTF-8?q?en=20extended=20regarding=20setup=20instructions=20for=20dev=20?= =?UTF-8?q?environment.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- Makefile | 2 +- README.md | 7 ++++++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index 6fbe467..012af3f 100644 --- a/Makefile +++ b/Makefile @@ -8,7 +8,7 @@ DMG_NAME="dmg" .PHONY: install install: ## Install the poetry environment and install the pre-commit hooks @echo "🚀 Creating virtual environment using pyenv and poetry" - @poetry install + @poetry install --all-extras --with dev,docs @poetry run pre-commit install @poetry shell diff --git a/README.md b/README.md index 3444875..b1fe1f4 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,8 @@ If you like to have the GUI version only as a binary, have a look at the Clone this repository and install the dependencies: ```bash +# First, install Poetry. On some operating systems you need to use `pip` instead of `pipx` +pipx install --upgrade poetry poetry install --all-extras --with dev,docs ``` @@ -131,9 +133,12 @@ This needs to be done for each created / modified `*.ui` file accordingly. To build the project use this command: ```bash +# Install virtual environment and dependencies if not already done make install -# OR +# Build macOS GUI make gui-macos +# Check build output +ls dist/ ``` See the `Makefile` for all available build commands.