https://github.com/winbench/config-dev
The configuration for a Bench environment to contribute to Bench.
https://github.com/winbench/config-dev
Last synced: 4 months ago
JSON representation
The configuration for a Bench environment to contribute to Bench.
- Host: GitHub
- URL: https://github.com/winbench/config-dev
- Owner: winbench
- Created: 2016-12-23T14:09:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-02-05T12:37:43.000Z (about 7 years ago)
- Last Synced: 2024-08-13T07:04:17.563Z (8 months ago)
- Size: 11.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - winbench/config-dev - The configuration for a Bench environment to contribute to Bench. (Others)
README
Bench Development Configuration
===============================
This is the user configuration for a [Bench](http://mastersign.github.io/bench)
environment to build the Bench system itself and its documentation.
Use this repository as the source for the user configuration,
in case you check out the [Bench repository](https://github.com/mastersign/bench)
and initialize the configuration.
## Prerequisites for Building Bench
The usual way:
* [Microsoft Visual Studio ≥ 2015][VS] (e.g. Community Edition)
* if VS ≥ 2017: [Microsoft Build Tools 2015][MSBuild2015]
* [Sandcastle Help File Builder][SHFB] with VS integration
Without Visual Studio, e.g. for building on a server:
* [Microsoft .NET Framework ≥ 4.5 SDK][.NET-SDK]
* [Microsoft Build Tools 2015][MSBuild2015]
* [Sandcastle Help File Builder][SHFB]
## Setting Up the Bench Project
You need [Git][] already setup on your system.
If Git is available in the PowerShell, you can clone, build and initialize
the Bench project directory with the following lines:
```ps1
# clone the Bench project
git clone -b dev https://github.com/mastersign/bench.git ".\bench dev"
cd ".\bench dev"
# clone this development configuration
git clone https://github.com/mastersign/bench-dev-config.git ".\config"
# clone the app libraries
git clone https://github.com/mastersign/bench-apps-core.git .\applibs\core
git clone https://github.com/mastersign/bench-apps-default.git .\applibs\default
# load the app libraries into the Bench environment
robocopy .\applibs .\libs\applibs /MIR /XD .git /NJH /NJS
# build Bench in debug mode
build\build-debug.ps1
# initialize the Bench environment
auto\bin\bench.exe -v m i
```
## Building the Bench Documentation
After running `build\build-docs.ps1`, the complete documentation should be build in `docs\public`.
## License
This project is released under the MIT license.
Copyright © by Tobias Kiertscher .
[Git]: https://git-scm.com/
[.NET-SDK]: https://www.microsoft.com/en-US/download/details.aspx?id=42637
[MSBuild2015]: https://www.microsoft.com/en-us/download/details.aspx?id=48159
[VS]: https://www.visualstudio.com/de/
[SHFB]: https://github.com/EWSoftware/SHFB/releases