Add find entry method

[hubacji1/bcar.git] / README.md

diff --git a/README.md b/README.md
index 7405414fbbe123a06f075138add0d9339e8e8504..b6f0c83996a5c2a04fb2418a5aa594c32a208ac0 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,2 +1,58 @@
-# BCar
+BCar
+====
+
 BCar is a C++ library with some geometric bicycle car computations.
+
+License
+-------
+
+The project is published under [MIT License][1].
+
+[1]: ./LICENSE
+
+Build
+-----
+
+To build the project run the following commands:
+
+    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.
+4. Do not end the subject line with a period.
+5. Use the imperative mood in the subject line.
+6. Wrap the body at 72 characters.
+7. Use the body to explain what and why vs. how.
+
+[2]: https://en.wikipedia.org/wiki/Test-driven_development
+[5]: https://chris.beams.io/posts/git-commit/
+
+Documentation
+-------------
+
+The documentation is generated by Doxygen, at least version `1.8.15` is needed.
+Just run `doxygen` in the project root directory.