From 3e2e8df594913b2a35a73b9e33e2e704471a4e96 Mon Sep 17 00:00:00 2001 From: Ethan P Date: Sat, 30 Jul 2022 17:01:03 -0700 Subject: [PATCH] docs: Update README about manual files Manual files are now generated and installed by default. --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9026acb..635b06d 100644 --- a/README.md +++ b/README.md @@ -110,11 +110,10 @@ If you only want to install a single script, you can run the build process and c -**Manuals:** (EXPERIMENTAL) +**Manuals:** -You can specify `--manuals` to have the build script generate a `man` page for each of the markdown documentation files. -This is an experimental feature that uses a non-compliant Markdown "parser" written in Bash, and there is no guarantee -as for the quality of the generated manual pages. +The build script will automatically generate a `man` page for each of the markdown documentation files. +This is a beta feature that uses a non-compliant Markdown "parser" written in Bash, and there is no guarantee towards the quality of the generated manual pages. If you do not want to generate manual files, you can provide the `--no-manuals` option to disable manual file generation.