summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorEdward Thomson <ethomson@edwardthomson.com>2017-11-12 11:59:56 +0000
committerEdward Thomson <ethomson@edwardthomson.com>2017-11-24 22:24:43 +0000
commitb2d54cfa345edfece7c214f7f2521ecd9d5c3097 (patch)
tree92f004fb6448a736b8871290ddb404432822124e /README.md
parent59ffb512a5e297c695e394a7a8e2bb456869c684 (diff)
downloadlibgit2-b2d54cfa345edfece7c214f7f2521ecd9d5c3097.tar.gz
README: suggest `ctest -V` for getting started
Suggest that users run `ctest -V` instead of `make test` when getting started. `ctest -V` is superior over alternatives as: 1. Unlike `make test`, it gives output. Users getting started with the library believe that it is hung. 2. `ctest -V` shows verbose output; showing suite names is helpful for giving users more feedback immediately.
Diffstat (limited to 'README.md')
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 0d2305957..6732e40c6 100644
--- a/README.md
+++ b/README.md
@@ -135,7 +135,7 @@ Alternatively you can point the CMake GUI tool to the CMakeLists.txt file and ge
Once built, you can run the tests from the `build` directory with the command
- $ make test
+ $ ctest -V
Alternatively you can run the test suite directly using,