From 53783b816f924f5f6f58c443498dd14ae9d3596f Mon Sep 17 00:00:00 2001 From: Romain Failliot Date: Sat, 24 Aug 2024 11:33:16 -0400 Subject: [PATCH] docs: improve devs setup structure --- CHANGELOG.md | 1 + docs/developers/developers-setup.md | 22 ++++++++++------------ 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0ef98a3..2c0763f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 diff --git a/docs/developers/developers-setup.md b/docs/developers/developers-setup.md index fa694f3..cb7526c 100644 --- a/docs/developers/developers-setup.md +++ b/docs/developers/developers-setup.md @@ -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 @@ -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