summaryrefslogtreecommitdiff
path: root/README.template
blob: 5d08037bbb2a2ccb19273835133ce46cff9fbd78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Here is a script and a Makefile for generating a <NAME> docset for Dash. The script is based on the dash-docset-generation-template

- <NAME>: <UPSTREAM LINK>
- Dash: https://kapeli.com/dash
- dash-docset-generation-template: https://github.com/lshprung/dash-docset-generation-template

To generate a docset from the latest edition of the <NAME> Manual, simply
execute `make` from the same directory as this README file. The latest edition
will be downloaded from <UPSTREAM HOST> and packaged appropriately.

Requirements:

- any POSIX-compliant shell
- curl    - https://curl.se/
- make    - https://www.gnu.org/software/make/
- pup     - https://github.com/ericchiang/pup
- sqlite3 - https://www.sqlite.org/index.html