A tool for embedding documentation on PE files
AutoHotkey
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
res
COPYING
COPYING.LESSER
DocsEmbedder.ahk
LibSetup.ahk
README.md

README.md

DocsEmbedder

PLEASE NOTE THAT THIS IS BETA SOFTWARE. I'M IN NO WAY RESPONSIBLE FOR ANY DATA LOSS.

DocsEmbedder

DocsEmbedder is a tool that can embed a set of html related documentation files inside a PE (portable executable) file. The documentation can then be referenced and visualized using the res:// protocol with a compatible browser or ActiveX control.

One of the way to embed a documentation is to write the desired markdown files, build a site with MkDocs and then embed the resulting files with DocsEmbedder, flattening them first. This document is actually embedded in the binary release of DocsEmbedder and can be visualized clicking on its Help menu item.

Download

The build archive is here on GitHub.

Files

Name Description
docs\ Folder containing the documentation, built with MkDocs.
res\ Folder containing icon resources and program logo.
COPYING GNU General Public License.
COPYING.LESSER GNU Lesser General Public License.
DocsEmbedder.ahk Main source file.
LibSetup.ahk Libraries setup script.
README.md This document.

How to compile

DocsEmbedder should be compiled with the Ahk2Exe compiler, that can be downloaded from the AHKscript download page.

Run the LibSetup.ahk script in advance to retrieve the required libraries from GitHub.

Browse to the files so that the fields are filled as follows:

Source:      path\to\DocsEmbedder.ahk
Destination: path\to\DocsEmbedder.exe
Custom Icon: path\to\Icon.ico

Select a Base File indicating your desired build and click on the > Convert < button. Don't use MPRESS.

Embed the documentation into the resulting exe using the script version of the program.

The documentation site is built with MkDocs.

Full README available here