Skip to content

Commit

Permalink
nix setup: add entry in CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nazarewk authored and friday committed Nov 21, 2023
1 parent 63a5c2e commit 361244b
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,25 @@ For the v6 branch you need the the following to setup the local build environmen

</details>

<details>
<summary>Nix package manager / NixOS</summary>

1. build your development interpreter with `./ul build-nix-dev`
2. use the development interpreter (`./nix/dev/bin/python`) by either of:
- pointing your favorite IDE to use it, make sure it adds repository root to `PYTHONPATH`,
- using it directly from repository root (otherwise you will use the version of code built with environment),
3. rebuild the interpreter when project dependencies change,

Alternatively you can run the current code directly `./ul run-nix <arg1> <arg2...>`, without any IDE completion.

Jetbrains IDEs will have trouble discovering GTK objects (`from gi.repository import ...` are underlined red).
You will need to instruct it to build stub files from binaries by:
1. placing your cursor over red-underlined import,
2. pressing `Alt+Enter` to invoke a dropdown menu with suggested fixes,
3. selecting `Generate stubs for binary module gi.repository.Gtk`

</details>

#### Running the app from the local repository

1. `git clone` the repository locally
Expand Down

0 comments on commit 361244b

Please sign in to comment.