From c0393d0ca1d3fa75a71fa224451310de29e36fa9 Mon Sep 17 00:00:00 2001 From: Julien Dessaux Date: Mon, 4 Oct 2021 20:10:02 +0200 Subject: Improved readme --- README.md | 17 +++++++++++++---- nimfunge98.nimble | 2 +- 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": -- cgit v1.2.3