Martchus
/
cpp-utilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Document tidying/clang-format

This commit is contained in:
Martchus 2017-04-04 00:53:00 +02:00
parent 8799698f01
commit 0a4fc2d326
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -31,6 +31,7 @@ The library utilizes:
* cppunit for unit tests (optional) * cppunit for unit tests (optional)
* Doxygen for API documentation (optional) * Doxygen for API documentation (optional)
* Graphviz for diagrams in the API documentation (optional) * Graphviz for diagrams in the API documentation (optional)
* clang-format for tidying (optional)
#### Runtime dependencies #### Runtime dependencies
* The c++utilities library itself only needs * The c++utilities library itself only needs
@ -43,6 +44,7 @@ Just run:
``` ```
cd "path/to/build/directory" cd "path/to/build/directory"
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/final/install/location" "path/to/projectdirectory" cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX="/final/install/location" "path/to/projectdirectory"
make tidy # format source files (optional)
make make
make check # build and run unit tests (optional) make check # build and run unit tests (optional)
make apidoc # build API documentation (optional) make apidoc # build API documentation (optional)