Skip to content

Latest commit

 

History

History
39 lines (21 loc) · 1.96 KB

README.md

File metadata and controls

39 lines (21 loc) · 1.96 KB
Raw

##Entelect.Core Build status

##What is it?

Core .net libraries used by Entelect

##How To Use

Install via NuGet

Read the Documentation

##How To Contribute

###Setup

Entelect.Core is built using Microsoft Visual Studio.

Sandcastle Help File Builder is used to generate documentation from XML comments embedded into the source code. All the components needed for Sandcastle can be easily installed using this Guided Installer. Once downloaded, unzip and run the SandcastleInstaller.exe. You will be guided through the installation process and prompted to install the various components. You do NOT have to install the microsoft help 2 compiler. Restart your PC after installation.

###Documentation

All code should be well documented using embedded XML comments.

The documentation is generated from these comments using Sandcastle. To build the documentation from visual studio, open the Entelect.sln, right click on the Entelect.Documentation project and select build.

To view the documentation, browse to ~\docs\Help\ and open the index.html file in your browser of choice.

###Testing All code should be supported by unit tests. Unit tests can be found in the Entelect.Tests project. NUnit is the testing framework of choice.

###Continious Integration Teamcity is used as a build and test runner for both the master and develop branches.

###Suggested Tools

  • Visual Studio 2012 or higher
  • Markdown Pad 2 for editing the readme.md