Skip to content

Commit aa71d99

Browse files
committed
✨ Readme and Makefile have been extended regarding setup instructions for dev environment.
1 parent 9038710 commit aa71d99

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ DMG_NAME="dmg"
88
.PHONY: install
99
install: ## Install the poetry environment and install the pre-commit hooks
1010
@echo "🚀 Creating virtual environment using pyenv and poetry"
11-
@poetry install
11+
@poetry install --all-extras --with dev,docs
1212
@poetry run pre-commit install
1313
@poetry shell
1414

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ If you like to have the GUI version only as a binary, have a look at the
100100
Clone this repository and install the dependencies:
101101

102102
```bash
103+
# First, install Poetry. On some operating systems you need to use `pip` instead of `pipx`
104+
pipx install --upgrade poetry
103105
poetry install --all-extras --with dev,docs
104106
```
105107

@@ -131,9 +133,12 @@ This needs to be done for each created / modified `*.ui` file accordingly.
131133
To build the project use this command:
132134

133135
```bash
136+
# Install virtual environment and dependencies if not already done
134137
make install
135-
# OR
138+
# Build macOS GUI
136139
make gui-macos
140+
# Check build output
141+
ls dist/
137142
```
138143

139144
See the `Makefile` for all available build commands.

0 commit comments

Comments
 (0)