Skip to content

Commit 4a8a6d5

Browse files
authored
Update pre-commit installation instructions
1 parent a539a93 commit 4a8a6d5

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

gettingstarted/index.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,15 @@ FreeCAD depends on many other open source projects to provide the basic foundati
3535
3. Set up `pre-commit` (our automatic code-formatter and checker):
3636

3737

38-
- Install `pre-commit`:
39-
- `apt install pre-commit` (Debian/Ubuntu)
40-
- `dnf install pre-commit` (Fedora)
41-
- `pip install pre-commit`
42-
- `cd FreeCAD-src`
43-
- `pre-commit install`
38+
- Install `pre-commit` (either using your system package manager or pip):
39+
- Debian/Ubuntu: `apt install pre-commit`
40+
- Fedora: `dnf install pre-commit` (Fedora)
41+
- Other (pip in PATH): `pip install pre-commit`
42+
- Other (pip not in PATH): `python -m pip install pre-commit`
43+
- On a command line, change into your FreeCAD clone, e.g. `cd FreeCAD-src`
44+
- Run `pre-commit install` (or `python -m pre-commit install`, depending on your PATH)
45+
46+
4447

4548
4. We **strongly** recommend doing an out-of-source build, that is, build FreeCAD and put all generated files in a separate directory. Otherwise, the build files will be spread all over the source code and it will be much harder to sort out one from the other. A build directory can be created outside the FreeCAD source folder or inside:
4649

0 commit comments

Comments
 (0)