✨ Readme and Makefile have been extended regarding setup instructions for dev environment.
This commit is contained in:
@@ -8,7 +8,7 @@ DMG_NAME="dmg"
|
|||||||
.PHONY: install
|
.PHONY: install
|
||||||
install: ## Install the poetry environment and install the pre-commit hooks
|
install: ## Install the poetry environment and install the pre-commit hooks
|
||||||
@echo "🚀 Creating virtual environment using pyenv and poetry"
|
@echo "🚀 Creating virtual environment using pyenv and poetry"
|
||||||
@poetry install
|
@poetry install --all-extras --with dev,docs
|
||||||
@poetry run pre-commit install
|
@poetry run pre-commit install
|
||||||
@poetry shell
|
@poetry shell
|
||||||
|
|
||||||
|
|||||||
@@ -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:
|
Clone this repository and install the dependencies:
|
||||||
|
|
||||||
```bash
|
```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
|
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:
|
To build the project use this command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
# Install virtual environment and dependencies if not already done
|
||||||
make install
|
make install
|
||||||
# OR
|
# Build macOS GUI
|
||||||
make gui-macos
|
make gui-macos
|
||||||
|
# Check build output
|
||||||
|
ls dist/
|
||||||
```
|
```
|
||||||
|
|
||||||
See the `Makefile` for all available build commands.
|
See the `Makefile` for all available build commands.
|
||||||
|
|||||||
Reference in New Issue
Block a user