From 042b0f619ba63dec4f9ca6ca14a5b6c30459d704 Mon Sep 17 00:00:00 2001 From: Immo Landwerth Date: Sat, 15 Feb 2014 17:52:22 -0800 Subject: [PATCH] Replace 'How to Build.txt' by 'README.md' --- How to Build.txt | 36 ------------------------------------ README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 36 deletions(-) delete mode 100644 How to Build.txt create mode 100644 README.md diff --git a/How to Build.txt b/How to Build.txt deleted file mode 100644 index 993625b..0000000 --- a/How to Build.txt +++ /dev/null @@ -1,36 +0,0 @@ -How to build XML Schema Documenter -================================== - -Prerequisites -------------- - -1. Microsoft Visual Studio 2012 (Professional, Premium or Ultimate). - http://msdn.microsoft.com/en-us/vstudio/default.aspx - -2. Sandcastle Help File Builder (SHFB) Version 1.9.8 - http://shfb.codeplex.com/releases/view/105809 - - Please make sure you install the following components: - - Sandcastle - - Sandcastle Style Patch - - Sandcastle Help File Builder (SHFB) - - After the installtion, you need to reboot the machine - to make sure the new environment variables become - available - -3. Windows Installer XML (WiX) toolset Version 3.8 - http://wix.codeplex.com/releases/view/115492 - -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. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..b5f71ee --- /dev/null +++ b/README.md @@ -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