Basic texinfo dash docset

1 files changed, 19 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..162faaa
--- /dev/null
+++ b/README
@@ -0,0 +1,19 @@
+Here is a script and a Makefile for generating GNU Texinfo-related docsets for Dash. The script is based on the dash-docset-generation-template
+
+- GNU Texinfo: https://www.gnu.org/software/texinfo/
+- Dash: https://kapeli.com/dash
+- dash-docset-generation-template: https://github.com/lshprung/dash-docset-generation-template
+
+To generate docsets from the latest edition of the GNU Texinfo Manual 
+and the Standalone Info Reader 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:
+
+- 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