From a9413e16e8a8d160acb760a0971f25ef23d71e8c Mon Sep 17 00:00:00 2001 From: Louie S Date: Thu, 6 Jun 2024 16:47:11 -0400 Subject: Rework structure to be friendlier to end-users --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 9163367..ed9bd59 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,18 @@ # Dash Docset Builder -This is a repository providing sources building various Dash docsets using a Makefile. Supported docsets can be found under `./configs`. +This is a repository providing sources building various Dash docsets using a Makefile. Supported docsets can be found 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=...] +Usage: make DOCSET_NAME [BUILD_DIR=...] - DOCSET_NAME must be set to the name of a directory under ./configs. - BUILD_DIR can be set to a directory to build under. The default is the project root + DOCSET_NAME must be a directory under ./src/configs. + BUILD_DIR can be set to a directory to build under. The default is ./build -Examples: - make DOCSET_NAME=GNU_Make - make DOCSET_NAME=GNU_Make BUILD_DIR=build/ +Other possible targets: + archive - create .tgz archives for all docsets in BUILD_DIR (WIP) + clean - remove all docsets and .tgz archives from BUILD_DIR + $(BUILD_DIR)/$(DOCSET_NAME).docset - equivalent to DOCSET_NAME + $(BUILD_DIR)/$(DOCSET_NAME).tgz - create a .tgz archive of DOCSET_NAME ``` -- cgit