extern/bat-extras
1
0
Fork 0
mirror of https://github.com/eth-p/bat-extras.git synced 2025-02-08 05:09:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update README about manual files

Browse Source 
Manual files are now generated and installed by default.
This commit is contained in:
Ethan P 2022-07-30 17:01:03 -07:00 committed by GitHub
parent abda988cbd
commit 3e2e8df594
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -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.