Martchus
/
reflective-rapidjson
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Improve README.md

This commit is contained in:
Martchus 2017-10-28 22:52:31 +02:00
parent 0520341411
commit e1dca1d1a2
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -126,8 +126,8 @@ Optional:
* Doxygen for generating API documentation
* Graphviz for diagrams in the API documentation
Note that `reflective-rapidjson` and none of these dependencies are required at runtime by an application which
makes use of the `reflective-rapidjson`.
Note that Reflective RapidJSON itself and none of these dependencies are required at runtime by an application
which makes use of Reflective RapidJSON.
### How to build
Install all required dependencies and ensure the CMake script finds them. It is possible to build `c++utilities`
@ -154,9 +154,11 @@ cmake \
"$SOURCES/reflective-rapidjson"
# build library and generators
make
# run test (optional, requires CppUnit)
# build and run tests (optional, requires CppUnit)
make check
# generates API documentation (optional, reqquires Doxygen)
# build tests but do not run them (optional, requires CppUnit)
make tests
# generate API documentation (optional, reqquires Doxygen)
make apidoc
# install header files, libraries and generator
make install DESTDIR="/temporary/install/location"