Add point inside of circle check

[hubacji1/bcar.git] / README.md

diff --git a/README.md b/README.md
index ff824b884b92aabbdb631cc3bff00e889c8b75c4..24f9ed0b3204a88326f39bb3261bc5cf32b2846f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,24 +1,51 @@
-# BCar
+<!--
+SPDX-FileCopyrightText: 2021 Jiri Vlasak <jiri.vlasak.2@cvut.cz>
+
+SPDX-License-Identifier: GPL-3.0-only
+-->
+
+BCar
+====
+
 BCar is a C++ library with some geometric bicycle car computations.
 
-# License
-The project is published under [MIT License][1].
+License
+-------
+
+The project is published under [GNU GPLv3][1].
 
 [1]: ./LICENSE
 
-# Build
+Build
+-----
+
 To build the project run the following commands:
-```
-mkdir build
-cd build
-cmake ../
-make
-```
 
-# Contribute
-Use [OneFlow][3] branching model and keep the [changelog][4].
+    mkdir build
+    cd build
+    cmake ../
+    make
+
+To build with ninja:
+
+    mkdir build
+    cd build
+    cmake -DCMAKE_BUILD_TYPE=Release -G Ninja ../
+    ninja -v
+
+Contribute
+----------
+
+When adding feature or hotfix, use [Test-driven development][2]:
+
+1. Add tests to `ut` folder, add methods declaration, basic structure.
+2. Run tests (just `make` in `build` folder), check that tests *fail*.
+3. Implement functionality.
+4. Run tests, check that tests *pass*.
+5. Refactor.
 
 Write [great git commit messages][5]:
+
 1. Separate subject from body with a blank line.
 2. Limit the subject line to 50 characters.
 3. Capitalize the subject line.
@@ -27,17 +54,11 @@ Write [great git commit messages][5]:
 6. Wrap the body at 72 characters.
 7. Use the body to explain what and why vs. how.
 
-When adding feature or hotfix, use [Test-driven development (TDD)][2]:
-1. Add tests to `ut` folder, add methods declaration, basic structure.
-2. Run tests (just `make` in `build` folder), check that tests *fail*.
-3. Implement functionality.
-4. Run tests, check that tests *pass*.
-5. Refactor.
-
 [2]: https://en.wikipedia.org/wiki/Test-driven_development
-[3]: https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow
-[4]: ./CHANGELOG.md
 [5]: https://chris.beams.io/posts/git-commit/
 
-# Documentation
+Documentation
+-------------
+
 The documentation is generated by Doxygen, at least version `1.8.15` is needed.
+Just run `doxygen` in the project root directory.