This repository has been archived by the owner on Mar 13, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Replace 'How to Build.txt' by 'README.md'
- Loading branch information
1 parent
4b72804
commit 042b0f6
Showing
2 changed files
with
44 additions
and
36 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Usage | ||
|
||
1. Install [Sandcastle Help File Builder (SHFB) Version 1.9.8][shfb] | ||
|
||
Please make sure you install the following components: | ||
- Sandcastle | ||
- Sandcastle Style Patch | ||
- Sandcastle Help File Builder (SHFB) | ||
|
||
After the installation, you need to reboot the machine | ||
to make sure the new environment variables become | ||
available | ||
|
||
2. Install [XML Schema Documenter (XsdDoc) Version 1.9.8][xsddoc] | ||
|
||
3. Read the [documentation][docs] | ||
|
||
# Development | ||
|
||
## Prerequisites | ||
|
||
1. [Microsoft Visual Studio 2013 (Professional, Premium or Ultimate)][vs]. | ||
|
||
2. [Sandcastle Help File Builder (SHFB) Version 1.9.8][shfb] | ||
|
||
3. [Windows Installer XML (WiX) toolset Version 3.8][wix] | ||
|
||
## Building | ||
|
||
1. Run `Build\Build.bat` | ||
|
||
2. The folder `Output` will now contain the following subfolders: | ||
- `Bin`. Contains the binaries (compiled in `Release` configuration). | ||
- `Help`. Contains the help file. | ||
- `Release`. Contains the zipped setup, samples, and source code. | ||
- `Setup`. Contains the setup. | ||
- `Samples`. Contains several sample .chm files. | ||
- `Source`. Contains the complete source code. | ||
|
||
[shfb]: http://shfb.codeplex.com/releases/view/105809 | ||
[xsddoc]: http://xsddoc.codeplex.com/releases | ||
[docs]: http://xsddoc.codeplex.com/documentation | ||
[vs]: http://msdn.microsoft.com/en-us/vstudio/default.aspx | ||
[wix]: http://wix.codeplex.com/releases/view/115492 |