Skip to content
Snippets Groups Projects
Commit fc9c1fa2 authored by RWTHApp Service's avatar RWTHApp Service Committed by L. Ellenbeck
Browse files

Docs: updated documentation

parent bb91d5c4
No related branches found
No related tags found
No related merge requests found
...@@ -2,21 +2,30 @@ ...@@ -2,21 +2,30 @@
This template includes: This template includes:
* linting using
* Automatic building using cake * Automatic building using cake
* Automatic testing with nUnit * Automatic testing with NUnit
* Automatic linting with Resharper * 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 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), cake and Gitlab CI / CD * Automatic releases using semantic-release ([ESLint Code Convention](docs/ESLintConvention)), cake and Gitlab CI / CD
## What you need to do ## What you need to do
Place you c# project solution file in .src/. 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. Delete unused docs and update this README.
Add a nUnit test library to your solution. Add [NUnit](docs/nunit) tests to your solution.
## Building ## Building
Build this project by running either the build.ps1 or the build.sh script. Build this project by running either the build.ps1 or the build<span></span>.sh script.
The project will be build and tested. The project will be build and tested.
### Links
* [Commit convention](docs/ESLintConvention)
* [Everything possible with markup](docs/testdoc)
* [Adding NUnit tests](docs/nunit)
\ No newline at end of file
...@@ -2,23 +2,26 @@ ...@@ -2,23 +2,26 @@
This template includes: This template includes:
* linting using
* Automatic building using cake * Automatic building using cake
* Automatic testing with nUnit * Automatic testing with NUnit
* Automatic linting with Resharper * 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 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), cake and Gitlab CI / CD * Automatic releases using semantic-release ([ESLint Code Convention](ESLintConvention)), cake and Gitlab CI / CD
## What you need to do ## What you need to do
Place you c# project solution file in .src/. 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. Delete unused docs and update this README.
Add a nUnit test library to your solution. Add [NUnit](docs/nunit) tests to your solution.
## Building ## Building
Build this project by running either the build.ps1 or the build.sh script. Build this project by running either the build.ps1 or the build<span></span>.sh script.
The project will be build and tested. The project will be build and tested.
### Links ### Links
......
docs/images/add_a_package.png

19.2 KiB

docs/images/add_a_reference.png

21.3 KiB

docs/images/create_class_library.png

55.5 KiB

docs/images/create_project.png

59.3 KiB

docs/images/select_framework.png

33.2 KiB

docs/images/select_project.png

8.35 KiB

docs/images/test_code.png

85.3 KiB

## Add NUnit Tests
### Add Nunit test adapter
1. Choose **Tools > Extensions and Updates**
2. In the **Extensions and Updates** dialog box, expand the **Online** category and then **Visual Studio Marketplace**. Then, choose **Tools > Testing**.
2. Select the **NUnit test adapter** and then choose **Download.**
### Add Tests
1. Create a class library project and add it to your solution.
For convinience name it like your main project and add **.Tests** as a suffix.
![alt text](images/create_class_library.png "Select Class Library")
2. Install the plug-in. In **Solution Explorer**, select the class library project, and then choose **Manage NuGet Packages** from its right-click or context menu.
![alt text](images/add_a_package.png "Add a package")
3. In the **NuGet Package Manager** window, search for and select the plug-in (NUnit), and then choose **Install**.
![alt text](images/select_framework.png "Select Project")
The framework is now referenced in your project under **References**.
4. From the class library project's **References** node, select **Add Reference**.
![alt text](images/add_a_reference.png "Add a reference")
5. In the **Reference Manager** dialog box, select the project that contains the code you'll test.
![alt text](images/select_project.png "Select Project")
6. Code your unit test.
![alt text](images/test_code.png "Test Code")
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment