From b25ec09af080cff667fce9becc2fbb15b19c41bd Mon Sep 17 00:00:00 2001 From: louie Date: Wed, 18 Oct 2023 20:30:13 -0400 Subject: Remove template --- README | 17 +++++++++++++++++ README.md | 33 --------------------------------- README.template | 17 ----------------- 3 files changed, 17 insertions(+), 50 deletions(-) create mode 100644 README delete mode 100644 README.md delete mode 100644 README.template diff --git a/README b/README new file mode 100644 index 0000000..c4b49dc --- /dev/null +++ b/README @@ -0,0 +1,17 @@ +Here is a script and a Makefile for generating a ncurses docset for Dash. The script is based on the dash-docset-generation-template + +- ncurses: https://invisible-island.net/ncurses/ +- 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 ncurses, simply +execute `make` from the same directory as this README file. The latest edition +will be downloaded from www.invisible-island.net 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 diff --git a/README.md b/README.md deleted file mode 100644 index 774f7de..0000000 --- a/README.md +++ /dev/null @@ -1,33 +0,0 @@ -# Dash Docset Template - -This is a repository providing a template to package a Dash docset from HTML source documentation. Files that need to be manually configured are listed below. Additional fine tuning is also recommended, depending on the quirks of the documentation being packaged. An example docset packaging script for GNU Make using this template can be seen [here](https://github.com/lshprung/gnu-make-dash-docset) - -### `README.template` - -This file will provide a README for the packaging script. Replace ``, ``, and `` with appropriate values. - -### `Makefile` - -This file will build the docset. - -- `DOCSET_NAME` must be set -- `MANUAL_FILE` must be set - - If the script should download documentation from the internet, `MANUAL_URL` must also be set. If not, ensure a `.tgz` archive of the HTML documentation exists at `tmp/MANUAL.tgz` (where MANUAL is the name of the archive) - -### `src/icon.png` - -If you want to associate an icon with the docset, it should be saved to `src/icon.png`. Make sure to uncomment the corresponding line in `Makefile` to include the icon in the docset. - -### `src/index.sh` - -This is the main script that builds the docset index. This script does not require any manual modifications, but you will probably want to make additions/changes to improve the quality of your docset and accomodate any quirks. - -### `src/Info.plist` - -This file contains metadata for the docset. Replace `` with appropriate values. It may be useful to refer to the `Info.plist` file of an existing docset for reference. - ---- - -### Credits - -Created by [lshprung](https://github.com/lshprung), and originally based on [benzado](https://github.com/benzado)'s [gnu-make-dash-docset](https://github.com/benzado/gnu-make-dash-docset). diff --git a/README.template b/README.template deleted file mode 100644 index c4b49dc..0000000 --- a/README.template +++ /dev/null @@ -1,17 +0,0 @@ -Here is a script and a Makefile for generating a ncurses docset for Dash. The script is based on the dash-docset-generation-template - -- ncurses: https://invisible-island.net/ncurses/ -- 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 ncurses, simply -execute `make` from the same directory as this README file. The latest edition -will be downloaded from www.invisible-island.net 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 -- cgit