Merge pull request #25 from dirkolbrich/master

Author: chennes

codeformatting/index.md

@@ -18,9 +18,9 @@ FreeCAD's codebase currently includes a preliminary [.clang-format](https://gith
 ### C++ Copyright Header
 
 The following is the standard C++ copyright header that should be included in all new C++ files (and backported to files a developer is making significant changes to if they do not already have this format).
-```
-// SPDX-License-Identifier: LGPL-2.1-or-later
 
+```cpp
+// SPDX-License-Identifier: LGPL-2.1-or-later
 /****************************************************************************
  *                                                                          *
  *   Copyright (c) <YEAR> <YOUR NAME> <YOUR EMAIL>                          *
@@ -52,7 +52,7 @@ There is no unified Python coding style agreed upon for the FreeCAD codebase: ea
 
 The following is the standard Python copyright header that should be included in all new Python files (and backported to files a developer is making significant changes to if they do not already have this format).
 
-```
+```python
 # SPDX-License-Identifier: LGPL-2.1-or-later
 # ***************************************************************************
 # *                                                                         *

gettingstarted/index.md

@@ -13,40 +13,49 @@ Working on FreeCAD is similar to working on may other open-source projects. This
 ## Build Environment
 
 To work on FreeCAD you will need CMake, git, a code editor, a C++ compiler, and a Python interpreter. Many different combinations work:
-* On Linux, it's common to use vim, emacs, KDevelop, or CLion as your editor. Compilation with GCC and Clang is supported.
-* On Windows we support Visual Studio, Visual Studio Code, and CLion for development, all using the MSVC compiler toolchain.
-* On MacOS you will need to install the XCode command line tools, and can use XCode, Visual Studio Code, or CLion as your editor.
+
+- On Linux, it's common to use vim, emacs, KDevelop, or CLion as your editor. Compilation with GCC and Clang is supported.
+- On Windows we support Visual Studio, Visual Studio Code, and CLion for development, all using the MSVC compiler toolchain.
+- On MacOS you will need to install the XCode command line tools, and can use XCode, Visual Studio Code, or CLion as your editor.
 
 Other combinations may work as well, these are just the ones that you will be able to get help with most readily on the [FreeCAD Forum](https://forum.freecad.org).
 
 ## Dependencies
 
 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:
-* Linux: https://wiki.freecad.org/Compile_on_Linux
-* Windows: https://wiki.freecad.org/Compile_on_Windows
-* Mac: https://wiki.freecad.org/Compile_on_MacOS
+
+- Linux: https://wiki.freecad.org/Compile_on_Linux
+- Windows: https://wiki.freecad.org/Compile_on_Windows
+- Mac: https://wiki.freecad.org/Compile_on_MacOS
 
 ## Setting up for Development
 
-1) Fork https://github.com/FreeCAD/FreeCAD on GitHub
-2) Clone your fork: for example, on the command line you can use `git clone https://github.com/YourUsername/FreeCAD FreeCAD-src`
-3) Set up `pre-commit` (our automatic code-formatter and checker):
-   1) `pip install pre-commit`
-   2) `cd FreeCAD-src`
-   3) `pre-commit install`
-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.
-5) CMake will generate project files that can be read by your IDE of choice. See your IDE's documentation for details. In general:
-   * On Linux, compile with a command like `cmake --build /path/to/FreeCAD-src` run from your build directory.
-   * 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).
-   * 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.
-6) If you plan on submitting a PR, create a branch: `git checkout -b fixTheThing`
+1. Fork https://github.com/FreeCAD/FreeCAD on GitHub
+2. Clone your fork: for example, on the command line you can use `git clone https://github.com/YourUsername/FreeCAD FreeCAD-src`
+3. Set up `pre-commit` (our automatic code-formatter and checker):
+ 
+
+    - `pip install pre-commit`
+    - `cd FreeCAD-src`
+    - `pre-commit install`
+  
+ 
+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.
+5. CMake will generate project files that can be read by your IDE of choice. See your IDE's documentation for details. In general:
+ 
+    - On Linux, compile with a command like `cmake --build /path/to/FreeCAD-src` run from your build directory.
+    - 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).
+    - 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.
+ 
+6. If you plan on submitting a PR, create a branch: `git checkout -b fixTheThing`
 
 ## Submitting a PR
 
 The basic process is:
-1) Write some code (and possibly some unit tests)
-2) `git add file1.cpp file2.cpp`
-3) `git commit -m "Sketcher: Fixed bug in constraints" -m "Added foo to bar. Fixes #1234."`
-    * When running `git commit` our pre-commit hooks will run to check your code. If the scripts had to make changes, you will have to `git add` the changed files and run `git commit` again.
-4) `git push` to send your changes to GitHub
-5) Visit https://github.com/FreeCAD/FreeCAD -- at the top of the screen you should see a yellow banner suggesting you create a Pull Request. Follow the instructions on the site to get the process started.
+
+1. Write some code (and possibly some unit tests)
+2. `git add file1.cpp file2.cpp`
+3. `git commit -m "Sketcher: Fixed bug in constraints" -m "Added foo to bar. Fixes #1234."`
+    - When running `git commit` our pre-commit hooks will run to check your code. If the scripts had to make changes, you will have to `git add` the changed files and run `git commit` again.
+4. `git push` to send your changes to GitHub
+5. Visit https://github.com/FreeCAD/FreeCAD -- at the top of the screen you should see a yellow banner suggesting you create a Pull Request. Follow the instructions on the site to get the process started.