Skip to content

Commit

Permalink
docs: improve devs setup structure
Browse files Browse the repository at this point in the history
  • Loading branch information
MightyCreak committed Aug 24, 2024
1 parent d631dc1 commit ed81c75
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Translation: add 'nl' in LINGUAS (@hugok79)
- Update pypi packages (@MightyCreak)
- Add pre-commit git hooks to run linters (@MightyCreak)
- Docs: improve devs setup structure (@MightyCreak)

## 0.9.0 - 2024-01-13

Expand Down
26 changes: 13 additions & 13 deletions docs/developers/developers-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,9 @@ Diffuse depends on these projects:
* Meson
* Flatpak and Flatpak builder (Linux only)

### Install git hooks (optional)
### Install the dependencies

There is a pre-commit git hook that runs some linters on the source code before committing.

To install the git hooks (for the repository only), run this command:

```sh
git config --local core.hooksPath ./.githooks
```

## Install the dependencies

### Install the system dependencies
#### Install the system dependencies

It's a bit difficult to get the command lines for all the systems, but these
examples should be enough to find the packages on most systems.
Expand Down Expand Up @@ -58,7 +48,7 @@ brew install meson python3 py3cairo pygobject3 gtk+3 librsvg
_Note: Tested on macOS 12.5 (Monterey)_
</details>

### Install the project dependencies
#### Install the project dependencies

To install the requirements just to execute the binary, run:

Expand All @@ -72,6 +62,16 @@ For developer tools, run this one instead (it includes requirements.txt):
pip3 install -r requirements.dev.txt
```

#### Install git hooks (optional)

There is a pre-commit git hook that runs some linters on the source code before committing.

To install the git hooks (for the repository only), run this command:

```sh
git config --local core.hooksPath ./.githooks
```

## Setup

### Setup on Linux using Flatpak
Expand Down

0 comments on commit ed81c75

Please sign in to comment.