diff --git a/doc/unit-tests.txt b/doc/unit-tests.txt new file mode 100644 index 00000000000..1168de7b70a --- /dev/null +++ b/doc/unit-tests.txt @@ -0,0 +1,18 @@ +Compiling/runing bitcoind unit tests +------------------------------------ + +bitcoind unit tests are in the src/test/ directory; they +use the Boost::Test unit-testing framework. + +To compile and run the tests: +cd src +make -f makefile.unix test_bitcoin # Replace makefile.unix if you're not on unix +./test_bitcoin # Runs the unit tests + +If all tests succeed the last line of output will be: +*** No errors detected + +To add more tests, add BOOST_AUTO_TEST_CASE's to the existing +.cpp files in the test/ directory or add new .cpp files that +implement new BOOST_AUTO_TEST_SUITE's (and add them to the +list of includes in test_bitcoin.cpp).