Skip to content

Commit

Permalink
docs: updated contributing guide with information about the shell's d…
Browse files Browse the repository at this point in the history
…ebugging options

FossilOrigin-Name: 2e0d7459879f6b9937a733517561b9fe5ce92cec4897b7e7087344117bc22876
  • Loading branch information
thindil committed Jan 15, 2024
1 parent 1a307cd commit 9573110
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,15 @@ on the project page. Please attach to that ticket file with diff changes, the
best if done with command `fossil patch`. Another diff program will work too.
In that situation, please add information which program was used to create the
diff file. If you prefer you can also use other options from [the contact page](https://www.laeran.pl/repositories/nish/wiki?name=Contact).

## Additional debugging options

### Using nimprofiler with the program

To build the program with **nimprofiler** support, compile it with command `nimble analyze`.
More information about **nimprofiler** you can find at [Nim blog](https://nim-lang.org/blog/2017/10/02/documenting-profiling-and-debugging-nim-code.html#profiling-with-nimprof).

### Running unit tests of the program

To execute all unit tests of the program, execute the command `nimble test`.
The program uses [Unittests2](https://github.com/status-im/nim-unittest2) package for tests. More information about running tests (running only selected tests, etc.) please look at the package documentation.

0 comments on commit 9573110

Please sign in to comment.