Skip to content
Snippets Groups Projects
Commit 983d0310 authored by Paul Nitzke's avatar Paul Nitzke
Browse files

Merge branch 'test-documentation' into 'master'

Provide instructions on how to run tests

See merge request !31
parents 4e0949f0 684886c8
No related branches found
No related tags found
1 merge request!31Provide instructions on how to run tests
......@@ -34,6 +34,8 @@ dotnet publish ./src/SparseTransform.CLI/SparseTransform.CLI.csproj -r <RID> -o
Both commands output to the SparseTransform directory at the project root. The output path can be changed as desired.
The project can also be built using the Visual Studio interface. Right click on the SparseTransform.CLI project and select _Publish_. Then set the flags accordingly.
## How to Build the Documentation
We currently use [Doxygen](https://www.doxygen.nl/) to generate an HTML documentation as well as the LaTeX files needed to generate a PDF manual. Make sure you have a working installation of Doxygen installed.
......@@ -62,4 +64,16 @@ If you do not have Make installed use `latexmk` (Obtainable e.g. via the MiKTeX
latexmk refman
```
The compiled PDF file is named `refman.pdf` and also stored in the `latex` folder.
\ No newline at end of file
The compiled PDF file is named `refman.pdf` and also stored in the `latex` folder.
## How to Run the NUnit Test Suite
> The instructions below assume that your working directory is at the project root
This project uses [NUnit](https://nunit.org/) for unit testing. The complete test suite can be run using the dotnet command
```
dotnet test
```
or the Visual Studio interface.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment