From 964d541dac77dd33f0ac516793a3ac3297599749 Mon Sep 17 00:00:00 2001 From: Louie Shprung Date: Tue, 18 Jun 2024 17:37:47 -0400 Subject: Fix documentation; fix bug when docsets don't have an icon; add flex --- README.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index c1a0a3e..5519b0f 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ # Dash Docset Builder -This is a repository providing sources building various Dash docsets using a Makefile. Supported docsets can be found as a submodule under `./src/configs`. Simply pass the name of the docset as a target for the Makefile (e.g., `make GNU_Make`). +This is a repository providing sources building various [Dash](https://kapeli.com/dash) docsets using a Makefile. Supported docsets can be found as a submodule under `./src/configs`. Simply pass the name of the docset as a target for the Makefile (e.g., `make GNU_Make`). ### Documentation + + ``` Usage: make DOCSET_NAME [BUILD_DIR=...] [NO_CSS=yes] [LOCALE=...] @@ -23,19 +25,21 @@ Other possible targets: This table shows which supported docsets support which options. All targets support the setting of DOCSET_NAME and BUILD_DIR. -| |NO_CSS|LOCALE| +| |LOCALE|NO_CSS| |--------------------------------------------------|------|------| -|[GNU_Make](http://www.gnu.org/software/make/) |✓ | | -|[debmake](https://salsa.debian.org/debian/debmake)| |✓ (see [here](./src/configs/debmake/README.md))| +|[debmake](https://salsa.debian.org/debian/debmake)|✓ (see [here](./src/configs/debmake/README.md))|| +|[flex](https://github.com/westes/flex)| | | | +|[GNU_Make](http://www.gnu.org/software/make/) | |✓ | ### Build Requirements This table shows the dependencies for each supported docset. Additionally, all docsets depend on a POSIX-compliant shell (e.g. [bash](https://www.gnu.org/software/bash/)), [make](https://www.gnu.org/software/make/), and [sqlite3](https://www.sqlite.org/index.html). -| |[curl](https://curl.se/)|[po4a](https://po4a.org/)|[pup](https://github.com/ericchiang/pup)| +| |[curl](https://curl.se/)|[po4a](https://po4a.org/)|[pup](https://github.com/ericchiang/pup)|[texinfo](https://www.gnu.org/software/texinfo/)| |-|------------------------|-------------------------|----------------------------------------| -|[GNU_Make](http://www.gnu.org/software/make/) |✓|✓| | -|[debmake](https://salsa.debian.org/debian/debmake)|✓| |✓| +|[debmake](https://salsa.debian.org/debian/debmake)|✓|✓| | | +|[flex](https://github.com/westes/flex) |✓| |✓|✓| +|[GNU_Make](http://www.gnu.org/software/make/) |✓| |✓| | ### Project Structure -- cgit