Skip to content

Commit 6b87cd5

Browse files
authored
Merge pull request #28 from yorikvanhavre/yorikvanhavre-patch-2
Small tweaks to getting started page
2 parents 288d8d5 + 3040420 commit 6b87cd5

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

gettingstarted/index.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,30 +24,37 @@ Other combinations may work as well, these are just the ones that you will be ab
2424

2525
FreeCAD depends on many other open source projects to provide the basic foundations of the program. There are many ways of installing these dependencies: for details and the complete list, see the following Wiki pages:
2626

27-
- Linux: https://wiki.freecad.org/Compile_on_Linux
28-
- Windows: https://wiki.freecad.org/Compile_on_Windows
29-
- Mac: https://wiki.freecad.org/Compile_on_MacOS
27+
- Linux: [https://wiki.freecad.org/Compile_on_Linux](https://wiki.freecad.org/Compile_on_Linux)
28+
- Windows: [https://wiki.freecad.org/Compile_on_Windows](https://wiki.freecad.org/Compile_on_Windows)
29+
- Mac: [https://wiki.freecad.org/Compile_on_MacOS](https://wiki.freecad.org/Compile_on_MacOS)
3030

3131
## Setting up for Development
3232

33-
1. Fork https://github.com/FreeCAD/FreeCAD on GitHub
33+
1. Fork [https://github.com/FreeCAD/FreeCAD](https://github.com/FreeCAD/FreeCAD) on GitHub
3434
2. Clone your fork: for example, on the command line you can use `git clone https://github.com/YourUsername/FreeCAD FreeCAD-src`
3535
3. Set up `pre-commit` (our automatic code-formatter and checker):
3636

3737

38-
- `pip install pre-commit`
38+
- `pip install pre-commit` or `apt install pre-commit` on Debian/Ubuntu
3939
- `cd FreeCAD-src`
4040
- `pre-commit install`
4141

42+
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:
43+
44+
- `mkdir build`
45+
- `cd build`
46+
47+
5. Run CMake, either in via the CMake GUI or on the command line see the wiki compilation page for your operating system for a detailed list of options.
48+
6. CMake will generate project files that can be read by your IDE of choice. See your IDE's documentation for details. In general:
4249

43-
4. Run CMake, either in via the CMake GUI or on the command line see the wiki compilation page for your operating system for a detailed list of options. Note: we **strongly** recommend doing an out-of-source build, putting all generated files in their own directory.
44-
5. CMake will generate project files that can be read by your IDE of choice. See your IDE's documentation for details. In general:
45-
46-
- On Linux, compile with a command like `cmake --build /path/to/FreeCAD-src` run from your build directory.
50+
- On Linux, compile with a command like `cmake --build /path/to/FreeCAD-src` run from your build directory ( or `cmake --build ..` if your build directory is inside FreeCAD-src).
4751
- On Windows with Visual Studio, build the "ALL_BUILD target" (you will have to change the path to the final executable the first time you try to run that target).
4852
- On Mac on the command line use `cmake --build /path/to/FreeCAD-src` from your build directory, or if using CLion be sure to "Build All" the first time you run.
4953

50-
6. If you plan on submitting a PR, create a branch: `git checkout -b fixTheThing`
54+
7. If you plan on submitting a PR, create a branch:
55+
56+
- `git branch fixTheThing`
57+
- `git checkout fixTheThing` (or both commands in one go: `git checkout -b fixTheThing`)
5158

5259
## Submitting a PR
5360

0 commit comments

Comments
 (0)