README.md template

README.md-template

# {project name} - README

{project name} is a console application containing tests for {description}.
The tests are written using the [PetaTest][] unit testing framework. 

Simply compile and start the resulting executable to run the tests.
See the *"Selecting tests to run"* section, for details on how to specify which tests will run.


## Configuration

### App Settings in the App.config file:

TODO: 

### Selecting tests to run:

[PetaTest][] will process all classes that have been marked with the [TestFixture] attribute.
Within those classes, it will run all methods that are marked with [Test] attribute.

The results will be displayed to the console as well as written to an HTML file.
If the "/showreport" argument is set to "yes" in program.cs, the results file will
automatically open in the default browser when the tests have completed.
The name of the HTML results file is defined in the Program.cs module.

- To run individual tests, just change the [Test] attribute to [Test(Active=true)].
When run, only the tests with an Active parameter set to 'true' will execute.
- To omit a test, just change the [Test] attribute to [XTest].
- To omit a test fixture, just change the [TestFixture] to [XTestFixture].


## Pre-Requisites

### Tools and SDKs

- [NuGet Package Manager][] - Visual Studio extension to managing packages from a VS Project 

### Libraries/Packages

- PetaTest - a tiny , embeddable, dependency free Unit Testing framework.
- {additional libraries/packages}

**NOTE:** all libraries and packages have been loaded via the [NuGet Package Manager][]. 
The indented libraries (if any) are dependencies, and will be retrieved automatically by NuGet.


----------------------------------------------------------------
This README file is written using [Markdown][]. 

To see a formatted version, you can use the Visual Studio extension [Markdown Mode][],
an offline viewer such as [MD Pad][] and [MarkdownPad][],
or an online one such as [MarkdownViewer][] and [Markdown: Dingus][].


[PetaTest]:                                http://www.toptensoftware.com/petatest/
[NuGet Package Manager]:                   https://nuget.org/

[Markdown]:         http://daringfireball.net/projects/markdown/
[Markdown Mode]:    http://visualstudiogallery.msdn.microsoft.com/0855e23e-4c4c-4c82-8b39-24ab5c5a7f79
[MD Pad]:           http://apps.codigobit.info/2012/06/markdown-pad-markdown-textfile-editor.html
[MarkdownPad]:      http://markdownpad.com/
[MarkdownViewer]:   http://www.markdownviewer.com/
[Markdown: Dingus]: http://daringfireball.net/projects/markdown/dingus