2017-01-22 00:44:13 +03:00
|
|
|
# Short Version #
|
|
|
|
|
|
|
|
|
|
Run `make` command from top directory, then change to the build directory and
|
|
|
|
|
run `make` again.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# Detailed Version #
|
|
|
|
|
|
2015-06-13 21:59:00 +03:00
|
|
|
This project is designed for use with cmake.
|
|
|
|
|
|
|
|
|
|
The Makefile controls the overall build:
|
|
|
|
|
|
|
|
|
|
make
|
|
|
|
|
make release
|
|
|
|
|
|
|
|
|
|
Build a version optimized for performance.
|
|
|
|
|
|
|
|
|
|
make debug
|
|
|
|
|
|
2015-11-13 17:53:39 +03:00
|
|
|
Faster compile, but not as high performance. Enables test suite support.
|
2015-06-13 21:59:00 +03:00
|
|
|
|
|
|
|
|
make xcode
|
|
|
|
|
|
|
|
|
|
Create an Xcode project for use on OS X.
|
|
|
|
|
|
|
|
|
|
make windows
|
|
|
|
|
|
|
|
|
|
Used for cross-compiling for Windows using MinGW.
|
|
|
|
|
|
2015-06-14 17:21:11 +03:00
|
|
|
make documentation
|
|
|
|
|
|
|
|
|
|
Setup a `doxygen` configuration file based on project information, and then
|
|
|
|
|
generate HTML and LaTeX documentation.
|
|
|
|
|
|
2015-06-13 21:59:00 +03:00
|
|
|
make clean
|
|
|
|
|
|
|
|
|
|
Clean up the `build` directory.
|
|
|
|
|
|
|
|
|
|
These commands control the `build` directory. Everything in this directory is
|
|
|
|
|
auto-generated. You should not manually change these files or put anything
|
|
|
|
|
else in there.
|
|
|
|
|
|
2017-01-22 00:44:13 +03:00
|
|
|
From within the `build` directory, you can run `make` again to actually
|
|
|
|
|
compile the softeare.
|
2015-06-13 21:59:00 +03:00
|
|
|
|
|
|
|
|
The setup is designed to support unit testing with CuTest. Functions along
|
|
|
|
|
the lines of `void Test*` will be located automatically and used to create the
|
|
|
|
|
test suite, which is run by:
|
|
|
|
|
|
|
|
|
|
./run_tests
|
|
|
|
|
|
|
|
|
|
Or
|
|
|
|
|
|
|
|
|
|
make test
|
|
|
|
|
|
|
|
|
|
(The `run_tests` approach will probably give more useful feedback if a test fails.)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Integration testing must be handled separately.
|
|
|
|
|
|
|
|
|
|
You can configure the `CMakeLists.txt` to support creating installers.
|
