summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorwillson-chen <willson.chenwx@gmail.com>2019-08-24 17:16:20 +0800
committerRalph Giles <giles@thaumas.net>2019-09-05 09:26:04 -0700
commitee859d89d0d1529162795b873dd38d42d26cae22 (patch)
tree193483835f9d8521048dd501827b9985c4c9f9b5
parentd50b8d7ac0fe9d0089062d0efdbd64a083d5f4c6 (diff)
downloadogg-git-ee859d89d0d1529162795b873dd38d42d26cae22.tar.gz
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 <giles@thaumas.net>
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
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.