From ee859d89d0d1529162795b873dd38d42d26cae22 Mon Sep 17 00:00:00 2001 From: willson-chen Date: Sat, 24 Aug 2019 17:16:20 +0800 Subject: README: Add Testing section add `make test` to README.md On windows platform, building with MinGW can run 'make check' (autoconf) and 'ctest' or 'make test' (cmake), while building with MSBuild can only run 'ctest -c Release|Debug'. Signed-off-by: Ralph Giles --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 63545e2..ce6502d 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,35 @@ Use Makefile generator which is default one. cmake .. make +## Testing ## + +This package includes a collection of automated tests. +Running them is not part of building nor installation but optional. + +### Unix-like System or MinGW ### + +If build under automake: + + make check + +If build under CMake: + + make test + +or: + + ctest + +### Windows with MSBuild ### + +If build with configuration type "Debug", then: + + ctest -C Debug + +If build with configuration type "Release", then: + + ctest -C Release + ## License ## THIS FILE IS PART OF THE OggVorbis SOFTWARE CODEC SOURCE CODE. -- cgit v1.2.1