summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 15 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..541e5e4
--- /dev/null
+++ b/README
@@ -0,0 +1,15 @@
+Here is a script and a Makefile for generating a GNU Make docset for Dash.
+
+- GNU Make: http://www.gnu.org/software/make/
+- Dash: https://kapeli.com/dash
+
+To generate a docset from the latest edition of the GNU Make Manual, simply
+execute `make` from the same directory as this README file. The latest edition
+will be downloaded from www.gnu.org and packaged appropriately.
+
+Requirements:
+
+- curl
+- make
+- ruby
+- sqlite3