README.md 974 Bytes
Newer Older
Marcel Nellesen's avatar
Marcel Nellesen committed
1
## C# Template
David Schimmel's avatar
David Schimmel committed
2

Marcel Nellesen's avatar
Marcel Nellesen committed
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
This template includes:

* Automatic building using cake
* Automatic testing with NUnit
* Automatic linting with Resharper
* Automatic documentation publishing using Gitlab CI / CD and a self written script which puts the docs in the docs folder to the wiki
* Automatic releases using semantic-release ([ESLint Code Convention](docs/ESLintConvention)), cake and Gitlab CI / CD

## What you need to do

Place you C# project solution file in .src/.
Make sure Create directory for solution is unticked.

![alt text](docs/images/create_project.png "Create a new Project")

Delete unused docs and update this README.

Add [NUnit](docs/nunit.md) tests to your solution.

## Building

Build this project by running either the build.ps1 or the build<span></span>.sh script.
The project will be build and tested.

### Links 

*  [Commit convention](docs/ESLintConvention.md)
*  [Everything possible with markup](docs/testdoc.md)
Petar Hristov's avatar
Petar Hristov committed
31
*  [Adding NUnit tests](docs/nunit.md)