diff --git a/README.md b/README.md index 8d015d6b7..ffa0c5307 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,29 @@ **CruiseControl.NET** is an automated continuous integration server for the .NET platform. It is a C# port of CruiseControl for Java. + + ## Releases Releases up to 1.8.5 can be downloaded from [sourceforge.net](https://sourceforge.net/projects/ccnet/) -## How to build +## Development + +### Requirements + +## Windows +1. Visual Studio 2019 or Visual Studio 2017 + Visual Studio 2019 Build Tools +2. Sandcastle Help Builder +3. Visual Studio Code with NSIS extension (from idleberg) + +## Linux +1. MonoDevelop or Rider from Jetbrains +2. Visual Studio Code with NSIS extension (from idleberg) + +### Compile and build We provide the following build scripts with CruiseControl.NET: -### Windows +## Windows 1. ```ps build.ps1 --target=default``` It will display the existing targets in the cake build script. @@ -39,7 +54,11 @@ The packaged distribution can be found in the "Publish" folder. This builds and packages the project WebDashboards. -### Linux +If running powershell scripts are disabled on your machine, you can run powershell with ExecutionPolicy disabled for the CruiseControl.NET build file: + +```powershell -ExecutionPolicy ByPass -File ./build.ps1 -target=build``` + +## Linux If you just cloned the CruiseControl.NET repository, run ```chmod u+x build.sh``` so you have execute permission on the build script. 1. ```./build.sh --target=default```