Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improve devs setup structure #240

Merged
merged 1 commit into from
Aug 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
22 changes: 10 additions & 12 deletions docs/developers/developers-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,6 @@ Diffuse depends on these projects:
* Meson
* Flatpak and Flatpak builder (Linux only)

### 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
```

## Install the dependencies

### Install the system dependencies

It's a bit difficult to get the command lines for all the systems, but these
Expand Down Expand Up @@ -72,6 +60,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