corrade-vassal – Blame information for rev 1
?pathlinks?
Rev | Author | Line No. | Line |
---|---|---|---|
1 | vero | 1 | The library documentation is generated using external tools which currently create: |
2 | |||
3 | * A HTML Website http://lib.openmetaverse.org/docs/trunk/ |
||
4 | * A compiled HTML Help file http://lib.openmetaverse.org/docs/trunk/OpenMetaverse.chm |
||
5 | |||
6 | These are generated by our automated build system nightly using the inline XML code documentation. |
||
7 | |||
8 | If you want to generate these documents locally you will need to do the following: |
||
9 | |||
10 | 1) Download and install the following tools: |
||
11 | The latest version of Microsoft's Sandcastle (currently the May 2008 release as of February 4, 2009) http://www.codeplex.com/Sandcastle |
||
12 | Patch to fix issues with the Sandcastle Themes: http://sandcastlestyles.codeplex.com/Release/ProjectReleases.aspx?ReleaseId=18784#DownloadId=48243 |
||
13 | Sandcastle Help File Builder: http://www.codeplex.com/SHFB (You will need version 1.7.0.0 or newer) |
||
14 | Microsoft HTML Help: http://go.microsoft.com/fwlink/?linkid=14188 (Not required for Vista) |
||
15 | .NET 3.5 SP1 http://www.microsoft.com/downloads/details.aspx?FamilyID=ab99342f-5d1a-413d-8319-81da479ab0d7&DisplayLang=en |
||
16 | |||
17 | |||
18 | 2) We use prebuild to configure and build this project, see the readme.txt in the projects root directory for |
||
19 | more information. To build with docs: from the project root directory run: "runprebuild.bat msbuild docs" followed |
||
20 | by compile.bat, this will generate the necessary xml documentation and assemblies, then create the html project documentation |
||
21 | |||
22 | |||
23 | Additionally if you have 7-Zip installed in the path, a zip archive will be created in the documentation tree |
||
24 | containing all the documentation in a compressed format see: http://www.7-zip.org/ |
||
25 | |||
26 | To serve the documentation from a PHP enabled server copy contents of sandcastle_php folder into the directory generated by Sandcastle. |