Skip to content

Commit

Permalink
Merge pull request #240 from MightyCreak/docs/change-devs-setup-struc…
Browse files Browse the repository at this point in the history
…ture

docs: improve devs setup structure
  • Loading branch information
MightyCreak authored Aug 24, 2024
2 parents debf4d0 + 53783b8 commit f3d63dd
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 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)

### Fixed

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

0 comments on commit f3d63dd

Please sign in to comment.