Add WinSW Developer Guide

DEVELOPER.md

@@ -0,0 +1,55 @@
+WinSW Developer Information
+===
+
+### Build Environment
+
+* IDE: [Visual Studio Community 2013](http://www.visualstudio.com/en-us/news/vs2013-community-vs.aspx) (free for open-source projects)
+* `winsw_key.snk` should be available in the project's root in order to build the executable
+ * You can generate the certificate in "Project Settings/Signing"
+ * The certificate is in <code>.gitignore</code> list. Please do not add it to the repository
+
+### Testing
+
+WinSW includes a set of tests powered by the [NUnit](https://www.nunit.org/) test framework.
+In order to run tests you can install [NUnit Console](https://github.com/nunit/nunit-console) on the build machine.
+
+Once you build the solution, you will be able to find the test DLL with dependencies in the `src/Test/winswTests/bin` directory.
+In NUnit Console you can just import projects from this directory and then run tests.
+
+### Continuous Integration
+
+Project has a continuous integration flow being hosted by AppVeyor ([project page](https://ci.appveyor.com/project/oleg-nenashev/winsw)).
+This CI instance automates building and testing of the Release configuration of WinSW. 
+See [the appveyor.yml file](./appveyor.yml) for more details.
+
+Current status: [![Build status](https://ci.appveyor.com/api/projects/status/i94752yal9iy77in?svg=true)](https://ci.appveyor.com/project/oleg-nenashev/winsw)
+
+### Releasing to GitHub and NuGet
+
+Releases are being performed to 3 locations: GitHub, NuGet, and Jenkins Maven Repository.
+For all these releases we use binaries being created by the special AppVeyor Job ([winsw-release](https://ci.appveyor.com/project/oleg-nenashev/winsw-release)).
+
+Here are the release steps:
+
+1. Integrate all pull requests you want to release to the master branch.
+2. Update [CHANGELOG](./CHANGELOG.md) and push changes to the master.
+3. Wait till the [AppVeyor build](https://ci.appveyor.com/project/oleg-nenashev/winsw) finishes for the last commit.
+4. Go to the [winsw-release job page](https://ci.appveyor.com/project/oleg-nenashev/winsw-g2fwp).
+5. If you are doing a release with a new feature, bump the second digit in the _Version_ setting (e.g. to `2.N.${build}`) and change the next build number to `0`. In such case the version in assembly info will be `2.N.0`
+6. Run the [winsw-release](https://ci.appveyor.com/project/oleg-nenashev/winsw-g2fwp) build. 
+Once it completes, ensure the version is correct.
+7. Click on the _Deploy_ button for the build.
+Then deploy changes to _GitHub Releases_ and NuGet using the available publishers.
+8. Go to [GitHub Releases](https://github.com/kohsuke/winsw/releases), find the published Release, click on _Edit release_ and then uncheck the _This is a pre-release_ checkbox to make the release public.
+
+
+### Releasing to the Maven repository (legacy)
+
+Maven repository is no longer the main source of releases,
+but WinSW can be deployed there on-demand.
+Some projects (e.g. [Jenkins](https://jenkins.io)) still depend on WinSW from the Maven repository.
+
+1. Make sure you have passed the Release steps above
+2. Modify the `winsw.version` property to the the release version (`WINSW_VERSION`)
+3. Modify version field to `${WINSW_VERSION}-SNAPSHOT`
+4. Run `mvn release:prepare release:perform`

README.md

@@ -58,6 +58,8 @@ See the [Installation Guide](doc/installation.md) for more details.
 
 ### Documentation
 
+User documentation:
+
 * [Installation Guide](doc/installation.md) - Describes the installation process for different systems and .NET versions
 * [Release notes](CHANGELOG.md)
 * Configuration:
@@ -71,6 +73,10 @@ See the [Installation Guide](doc/installation.md) for more details.
 * Configuration Management:
  * [Puppet Forge Module](doc/puppetWinSW.md)
 
+Developer documentation:
+
+* [Developer Guide](DEVELOPER.md)
+
 ### Release lines
 
 #### WinSW 2.x
@@ -94,9 +100,3 @@ This is an old baseline of WinSW.
 Currently it is in the maintenance-only state.
 New versions with fixes may be released on-demand.
 
-### Build Environment
-
-* IDE: [Visual Studio Community 2013](http://www.visualstudio.com/en-us/news/vs2013-community-vs.aspx) (free for open-source projects)
-* `winsw_key.snk` should be available in the project's root in order to build the executable
- * You can generate the certificate in "Project Settings/Signing"
- * The certificate is in <code>.gitignore</code> list. Please do not add it to the repository