adyxax/nimfunge98
Archived
1
0
Fork 0
Code Issues Activity

Improved readme

Browse source
This commit is contained in:
Julien Dessaux 2021-10-04 20:10:02 +02:00
parent 161f0a3bf6
commit c0393d0ca1
2 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -15,6 +15,7 @@ Current limitations are :
- [Quick install](#quick-install) - [Quick install](#quick-install)
- [Usage](#usage) - [Usage](#usage)
- [Building](#building) - [Building](#building)
- [Running tests](#running-tests)
## Dependencies ## Dependencies
@ -48,17 +49,25 @@ For a release build, use :
nimble build -d:release nimble build -d:release
``` ```
## Running tests
To run unit tests, use : To run unit tests, use :
``` ```
nimble tests nimble tests
``` ```
To run integration tests, use :
```
nimble integration
```
To calculate the code coverage of tests, use : To calculate the code coverage of tests, use :
``` ```
nimble coverage nimble coverage
``` ```
To run tests only on (for example) the stack module, use :
```
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
```

2
nimfunge98.nimble
View file

@ -13,7 +13,7 @@ requires "nim >= 1.4.8"
# Tasks # Tasks
task test, "Runs the test suite": task tests, "Runs the test suite":
exec "testament pattern \"tests/*.nim\"" exec "testament pattern \"tests/*.nim\""
task coverage, "Run all tests and calculate coverage": task coverage, "Run all tests and calculate coverage":