Skip to content

Commit 3da2af7

Browse files
committed
Include notes on bat-extras, ripgrep, and aliases in README
1 parent 37420ff commit 3da2af7

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,17 @@
11
# Bat - Docker mod for code-server
22

3-
This mod adds bat to code-server, to be installed/updated during container start.
3+
This mod adds [bat](https://github.com/sharkdp/bat) to code-server, to be installed/updated during container start.
4+
5+
Bat is a cat(1) clone with syntax highlighting and Git integration.
46

57
In code-server docker arguments, set an environment variable `DOCKER_MODS=somewatson/mods:code-server-bat`
68

7-
If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=somewatson/mods:code-server-bat|linuxserver/mods:openssh-server-mod2`
9+
If adding multiple mods, enter them in an array separated by `|`, such as `DOCKER_MODS=somewatson/mods:code-server-bat|linuxserver/mods:openssh-server-mod2`
10+
11+
### Bat-extras and Ripgrep
12+
13+
This mod also includes [bat-extras](https://github.com/eth-p/bat-extras) which has a dependency of [ripgrep](https://github.com/BurntSushi/ripgrep). Ripgrep has also been included because it is a requirment of bat-extras.
14+
15+
### Aliases
16+
17+
This mod includes aliases for `bat` in `bash` and `zsh`. Under Ubuntu `bat` gets installed as `batcat` to avoid a name collision. So, for convenience, an alias to set `bat="batcat"` is included for both `bash` and `zsh`.

0 commit comments

Comments
 (0)