summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Honz <exislow+github@gmail.com>2025-03-27 18:57:34 +0100
committerRobert Honz <exislow+github@gmail.com>2025-03-27 18:57:34 +0100
commitaa71d9993fa3325861304e1d50f6339441e6dbcc (patch)
tree53eb92848bb307e3dfe8789b01b8402bf4bf31b0
parent903871002c388035a298ea8ccb664e87197c5f4b (diff)
downloadtidal-dl-ng-aa71d9993fa3325861304e1d50f6339441e6dbcc.tar.gz
✨ Readme and Makefile have been extended regarding setup instructions for dev environment.
-rw-r--r--Makefile2
-rw-r--r--README.md7
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.