Commit 64c39c71 authored by Jannick Wolters's avatar Jannick Wolters
Browse files

fixed README.md

parent b4e938d3
......@@ -30,7 +30,7 @@ git submodule update
```bash
cd code/build/release
cmake -DCMAKE_BUILD_TYPE=Release ../../src
cmake -DCMAKE_BUILD_TYPE=Release ../../
make
```
If building in parallel is desired, change the last line to `make -jN`, where `N` optimally is equal to the number of available threads+1.
......@@ -39,7 +39,7 @@ If building in parallel is desired, change the last line to `make -jN`, where `N
```bash
cd code/build/release
cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ../../src
cmake -G Ninja -DCMAKE_BUILD_TYPE=Release ../../
ninja
```
......@@ -68,6 +68,7 @@ TBD
## Code structure
![Can't load image](doc/uml.png "UML diagram")
<br/><br/>
The diagram can be modified by opening `doc/uml.zargo` with `ArgoUML`.
## Coding style
......@@ -78,4 +79,4 @@ Please stick to the following coding style for easier code readability:
- any variable/function names have capital letters at each individual word e.g. `GetAllCellsAdjacentTo(Cell i)`
Please also use the provided `code/.clang-format` style format to format your code before pushing your latest commits.
Some editors offer to automatically apply the style format upon saving a file (e.g. `Qtcreator`).
\ No newline at end of file
Some editors offer to automatically apply the style format upon saving a file (e.g. `Qtcreator`).
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment