diff options
| author | Louie S <louie@example.com> | 2024-06-06 16:47:11 -0400 |
|---|---|---|
| committer | Louie S <louie@example.com> | 2024-06-06 16:47:11 -0400 |
| commit | a9413e16e8a8d160acb760a0971f25ef23d71e8c (patch) | |
| tree | 52148f7902c270f35c5820e3fb280af2ab6edacd /README.md | |
| parent | 973bbcd6a8af9695a937fdc754e384a917984d2a (diff) | |
Rework structure to be friendlier to end-users
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 16 |
1 files changed, 9 insertions, 7 deletions
@@ -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 ``` |