eiginn / norns-dash-docset

norns Lua API docset generator

norns-dash-docset

Generate a Norns docset for Dash using Dashing.

Usage

Requirements

• Git
• Dashing

Updating Norns

Execute checkout.sh to initialize the norns submodule and checkout the tag for the latest release:

$ ./checkout.sh

Generating the Docset

Execute generate.sh to generate the docset:

$ ./generate.sh

generate.sh will produce the following files in the build/ directory:

• docset.json - Updated docset configuration file for submitting to Kapeli/Dash-User-Contributions
• norns.tgz - Compressed norns Lua API docset

Distributing the Docset

1. Fork and clone the Kapeli/Dash-User-Contributions repository.

2. Copy the generated docset.json and norns.tgz files from the build/ directory to the docsets/norns directory of your local Dash-User-Contributions repository, overwriting the previous versions.

3. Commit and push your changes.

4. Create a pull request against the upstream Dash-User-Contributions repository.

Acknowledgements

Norns icon taken with permission from p3r7/rpmate.