diff --git a/README.md b/README.md index 53e7553a..eba45f02 100644 --- a/README.md +++ b/README.md @@ -9,13 +9,15 @@ A *cat(1)* clone with syntax highlighting and Git integration. ### Syntax highlighting -`bat` supports syntax highlighting for a large number of programming and markup languages: +`bat` supports syntax highlighting for a large number of programming and markup +languages: ![Syntax highlighting example](https://imgur.com/rGsdnDe.png) ### Git integration -`bat` communicates with `git` to show modifications with respect to the index (see left side bar): +`bat` communicates with `git` to show modifications with respect to the index +(see left side bar): ![Git integration example](https://i.imgur.com/2lSW4RE.png) @@ -23,11 +25,14 @@ A *cat(1)* clone with syntax highlighting and Git integration. ### From binaries -Check out the [Release page](https://github.com/sharkdp/bat/releases) for binary builds and Debian packages. +Check out the [Release page](https://github.com/sharkdp/bat/releases) for +binary builds and Debian packages. #### Arch Linux -On Arch Linux, you can install [the AUR package](https://aur.archlinux.org/packages/bat/) via yaourt, or manually: +On Arch Linux, you can install +[the AUR package](https://aur.archlinux.org/packages/bat/) via yaourt, or +manually: ```bash git clone https://aur.archlinux.org/bat.git @@ -37,8 +42,8 @@ makepkg -si ### From source -If you want to build to compile `bat` from source, you need Rust 1.24 or higher. -You can then use `cargo` to build everything: +If you want to build to compile `bat` from source, you need Rust 1.24 or +higher. You can then use `cargo` to build everything: ``` bash cargo install bat @@ -49,7 +54,10 @@ some dependencies to be built. ## Customization -`bat` uses the excellent [`syntect`](https://github.com/trishume/syntect/) library for syntax highlighting. `syntect` can read any [Sublime Text `.sublime-syntax` file](https://www.sublimetext.com/docs/3/syntax.html) and theme. +`bat` uses the excellent [`syntect`](https://github.com/trishume/syntect/) +library for syntax highlighting. `syntect` can read any +[Sublime Text `.sublime-syntax` file](https://www.sublimetext.com/docs/3/syntax.html) +and theme. To build your own language-set and theme, follow these steps: