add bat

[webi-installers/.git] / bat / README.md

diff --git a/bat/README.md b/bat/README.md
new file mode 100644 (file)
index 0000000..232a2ac
--- /dev/null
+++ b/bat/README.md
@@ -0,0 +1,39 @@
+---
+title: bat
+homepage: https://github.com/sharkdp/bat
+tagline: |
+  bat: A cat(1) clone with syntax highlighting and Git integration.
+description: |
+  `bat` is pretty much what `cat` would be if it were developed today in the world of Markdown, git, etc.
+---
+
+## How to alias as `cat`
+
+Update your `.bashrc`, `.zshrc`, or `.profile`
+
+```bash
+alias cat="bat --style=plain"
+```
+
+## How to change the default behavior
+
+Take a look at the config options:
+
+```bash
+bat --help
+```
+
+Check to see where your config file is:
+
+```bash
+echo 'N' | bat --generate-config-file
+```
+
+Edit the config file:
+
+`~/.config/bat/config`:
+
+```txt
+# no numbers or headers, just highlighting and such
+--style="plain"
+```