summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLouie S <louie@example.com>2023-09-19 15:16:16 -0400
committerLouie S <louie@example.com>2023-09-19 15:16:16 -0400
commit1866dd507d0e36ef4cadef454424865358f435ca (patch)
treeed4976f629d3fee65eb946cae485ec8f4d70c7da /README
parent24630a5f215cfc949bac6faa9864b8ed29ee4594 (diff)
NSIS docsetHEADmaster
Diffstat (limited to 'README')
-rw-r--r--README17
1 files changed, 17 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..31cd789
--- /dev/null
+++ b/README
@@ -0,0 +1,17 @@
+Here is a script and a Makefile for generating a NSIS (Nullsoft Scriptable Install System) docset for Dash. The script is based on the dash-docset-generation-template
+
+- NSIS: https://nsis.sourceforge.io/
+- 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 NSIS Manual, simply
+execute `make` from the same directory as this README file.
+The manual's source is included as in this project's source tree, and is
+originally sourced from Debian's nsis-doc package.
+
+Requirements:
+
+- any POSIX-compliant shell
+- make - https://www.gnu.org/software/make/
+- pup - https://github.com/ericchiang/pup
+- sqlite3 - https://www.sqlite.org/index.html