Update documentation to be more clear and descriptive

This commit is contained in:
Ethan P 2020-04-06 11:42:45 -07:00
parent 0c29a7e625
commit 9ec0d1797c
No known key found for this signature in database
GPG Key ID: 6963FD04F6CF35EA
5 changed files with 36 additions and 9 deletions

View File

@ -6,10 +6,29 @@ Bash scripts that integrate [bat](https://github.com/sharkdp/bat) with various c
## Scripts
- [`batgrep`](doc/batgrep.md) (ripgrep + bat)
- [`batman`](doc/batman.md) (man with bat)
- [`batwatch`](doc/batwatch.md) (watch files with bat)
- [`prettybat`](doc/prettybat.md) (pretty printing + bat)
### [`batgrep`](doc/batgrep.md)
Quickly search through and highlight files using [ripgrep](https://github.com/burntsushi/ripgrep).
<u>Requirements:</u> `ripgrep`
### [`batman`](doc/batman.md)
Read system manual pages (`man`) using `bat` as the manual page formatter.
### [`batwatch`](doc/batwatch.md)
Watch for changes in one or more files, and print them with `bat`.
<u>Requirements:</u> `entr` (optional)
### [`prettybat`](doc/prettybat.md)
Pretty-print source code and highlight it with `bat`.
<u>Requirements:</u> (see doc/prettybat.md)
&nbsp;
@ -55,7 +74,7 @@ This uses [shfmt](https://github.com/mvdan/sh) to perform minification.
**Installation:**
You can also specify `--install` and `--prefix=PATH` to have the build script automatically install the scripts for all users on the system. You may need to run the build script as root.
You can also specify `--install` and `--prefix=PATH` to have the build script automatically install the scripts for all users on the system. You may need to run the build script as root.
If you only want to install a single script, you can run the build process and copy the script directly out of the newly-created `bin` folder.

View File

@ -1,6 +1,8 @@
# bat-extras: batgrep
A script that combines [ripgrep](https://github.com/burntsushi/ripgrep) with bat's syntax highlighting and output formatting.
Quickly search through and highlight files using [ripgrep](https://github.com/burntsushi/ripgrep).
Search through files or directories looking for matching regular expressions (or fixed strings with `-F`), and print the output using `bat` for an easy and syntax-highlighted experience.

View File

@ -1,6 +1,8 @@
# bat-extras: batman
A script that allows bat to be used as a manual highlighter.
Read system manual pages (`man`) using `bat` as the manual page formatter.
Gone are the days of losing your place while reading through monotone manual pages. With `bat` and `batman`, you can read `man ifconfig` with beautiful 24-bit color and syntax higlighting.

View File

@ -1,6 +1,8 @@
# bat-extras: batwatch
Watch for changes in one or more files, and print them when updated.
Watch for changes in one or more files, and print them with `bat`.

View File

@ -1,6 +1,8 @@
# bat-extras: prettybat
A script that uses various pretty-printing tools and bat to display code in your terminal.
Pretty-print source code and highlight it with `bat`.
The only thing better than syntax highlighting? Syntax highlighting *and* code formatting. This script combines the best of both worlds by using [various formatters](#Languages) to format source files before using `bat` to highlight them.