diff --git a/Running-unit-tests.md b/Running-unit-tests.md new file mode 100644 index 0000000..a2afabc --- /dev/null +++ b/Running-unit-tests.md @@ -0,0 +1,17 @@ +The Dolphin source code contains unit tests that aim to: +* Help find bugs when porting Dolphin to a new platform +* Make refactoring and code changes safer by enforcing API contracts + +The tests are located in the ``Source/UnitTests`` directory and use the [Google Test](https://code.google.com/p/googletest/] framework. + +## Running tests on Windows + +**TODO** + +## Running tests on CMake-based systems (Linux / OS X) + +Use the ``unittests`` build target: + + make unittests + +Each module test can also be run independently using the binaries in ``$OUTPUT_DIR/Binaries/Tests``. \ No newline at end of file