aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJulien Dessaux2021-10-04 20:10:02 +0200
committerJulien Dessaux2021-10-04 20:10:02 +0200
commitc0393d0ca1d3fa75a71fa224451310de29e36fa9 (patch)
tree933fe6ea22bc2666861dc76fbf03ae40df8791e6
parentAdded a nimble task to run nimpretty on all gitted files (diff)
downloadnimfunge98-c0393d0ca1d3fa75a71fa224451310de29e36fa9.tar.gz
nimfunge98-c0393d0ca1d3fa75a71fa224451310de29e36fa9.tar.bz2
nimfunge98-c0393d0ca1d3fa75a71fa224451310de29e36fa9.zip
Improved readme
-rw-r--r--README.md17
-rw-r--r--nimfunge98.nimble2
2 files changed, 14 insertions, 5 deletions
diff --git a/README.md b/README.md
index 7c29829..311565d 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,7 @@ Current limitations are :
- [Quick install](#quick-install)
- [Usage](#usage)
- [Building](#building)
+- [Running tests](#running-tests)
## Dependencies
@@ -48,17 +49,25 @@ For a release build, use :
nimble build -d:release
```
+## Running tests
+
To run unit tests, use :
```
nimble tests
```
-To run integration tests, use :
+To calculate the code coverage of tests, use :
```
-nimble integration
+nimble coverage
```
-To calculate the code coverage of tests, use :
+To run tests only on (for example) the stack module, use :
```
-nimble coverage
+nim r tests/stack.nim
+```
+
+To debug these particular tests, use :
+```
+nim c --debugger:on --parallelBuild:1 --debuginfo --linedir:on tests/stack.nim
+gdb tests/stack
```
diff --git a/nimfunge98.nimble b/nimfunge98.nimble
index c3a0443..f62cd32 100644
--- a/nimfunge98.nimble
+++ b/nimfunge98.nimble
@@ -13,7 +13,7 @@ requires "nim >= 1.4.8"
# Tasks
-task test, "Runs the test suite":
+task tests, "Runs the test suite":
exec "testament pattern \"tests/*.nim\""
task coverage, "Run all tests and calculate coverage":