https://github.com/krypton-suite/help-files

Contains the SHFB projects, used to create offline help files.
https://github.com/krypton-suite/help-files

chm help krypton offline-help

Last synced: 7 months ago
JSON representation

Contains the SHFB projects, used to create offline help files.

• Host: GitHub
• URL: https://github.com/krypton-suite/help-files
• Owner: Krypton-Suite
• License: bsd-3-clause
• Created: 2020-04-10T16:19:35.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-11-19T09:03:55.000Z (almost 2 years ago)
• Last Synced: 2025-01-23T15:54:22.159Z (9 months ago)
• Topics: chm, help, krypton, offline-help
• Language: Batchfile
• Size: 1.33 MB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Krypton Toolkit Help Files

Welcome to the Krypton Toolkit help files repository!

## What is this repository for?

The Krypton Toolkit help files repository contains all the files required to create the end-user documentation for the Krypton Toolkit projects. You can download the latest files [here](https://github.com/Krypton-Suite/Help-Files/releases).

## Prerequisites

In order to build the documentation, you **must** have the following:-

  - The latest Krypton Toolkit DLL/XML files

  - The latest [Sandcastle Help File Builder](https://github.com/EWSoftware/SHFB/releases)

  - Time (plus a beverage of your choice ;-))

  

## To build

  - Open `Source\Standard Toolkit\Full Documentation\Full Toolkit Documentation\Full Toolkit Documentation.shfbproj`

  - Remove **all** entries under `Documentation Sources`

  - Add the current DLL/XML files to `Documentation Sources`

  - Update the version number in `Help File` -> `Help file version`

  - Build - Note: this will take some time

  

The generated output will be located in `Source\Standard Toolkit\Full Documentation\Full Toolkit Documentation\Help`. Rinse & repeat for the Extended Toolkit.