This repository contains the DreamSDK documentation.
The documentation is produced in 2 differents formats:
- In Microsoft Compiled HTML Help (
CHMfile); - Directly available online.
The CHM file will be embedded in the DreamSDK package, and can be viewed even
offline. Of course, the online version available on the website can be only
read if you have an internet connection, which is not the case for the CHM
file.
You need to install first the 2 utilities provided in the utils directory:
Please install htmlhelp.exe (1) then KEL_CHM_Creator_Setup.msi (2).
Then you can double-click on the src/dreamsdk.hhp file. KEL CHM Creator
should start.
In KEL CHM Creator you'll need to specify the location of the hhc
executable, usually installed in C:\Program Files (x86)\HTML Help Workshop\hhc.exe
on a 64-bit system.
Then when everything is ready, you can click on Build CHM file.
The dreamsdk.chm file will be generated in the ./bin directory.
The dreamsdk.chm file will be embedded in the DreamSDK Setup using the
prepare script, please browse the setup-helpers repository for more
information on that part.
First, just browse to the online directory.
You need to update the online/src/toc.html file according to your changes
made in the dreamsdk.chm file. Unfortunately, this is not automatic.
Double-click on the online.cmd script then upload the dist directory
content on the website.