diff --git a/docs/linux.md b/docs/linux.md index 1a2cebb68..6b594d7c2 100644 --- a/docs/linux.md +++ b/docs/linux.md @@ -63,8 +63,8 @@ Install [Poetry](https://python-poetry.org) using [pipx](https://pypa.github.io/ pipx install poetry ``` -[Clone the -repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository). +Next, [clone the +repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository), after which you need to execute the following consecutive commands: ```bash cd gaphor @@ -72,6 +72,10 @@ cd gaphor pyenv local 3.x.x # 3.x.x is the version you installed earlier poetry env use 3.x # ensures poetry /consistently/ uses latest major release poetry install +poetry run pre-commit install +``` +Now, you can run gaphor as +```bash poetry run gaphor ``` diff --git a/docs/macos.md b/docs/macos.md index 4df06d6ba..43bfbb4bb 100644 --- a/docs/macos.md +++ b/docs/macos.md @@ -20,11 +20,15 @@ Install [Poetry](https://python-poetry.org) using [pipx](https://pypa.github.io/ pipx install poetry ``` -[Clone the -repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository). +Next, [clone the +repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository), after which you can execute the following consecutive commands to install the poetry environment: ```bash cd gaphor poetry install +poetry run pre-commit install +``` +Now, you can run gaphor as +```bash poetry run gaphor ``` diff --git a/docs/windows.md b/docs/windows.md index 5662db377..a98e82da5 100644 --- a/docs/windows.md +++ b/docs/windows.md @@ -158,6 +158,11 @@ Install Gaphor's dependencies poetry install ``` +Install the git hook scripts +```Powershell +poetry run pre-commit install +``` + Reinstall PyGObject and pycairo using gvsbuild wheels ```PowerShell poetry run pip install --force-reinstall (Resolve-Path C:\gtk-build\build\x64\release\pygobject\dist\PyGObject*.whl)