bat/README.md

47 lines
1.3 KiB
Markdown
Raw Normal View History

2018-04-21 14:23:57 +02:00
# bat
2018-04-22 16:08:49 +02:00
[![Build Status](https://travis-ci.org/sharkdp/bat.svg?branch=master)](https://travis-ci.org/sharkdp/bat)
[![Version info](https://img.shields.io/crates/v/bat.svg)](https://crates.io/crates/bat)
2018-04-22 15:44:19 +02:00
*A cat(1) clone with wings.*
2018-04-21 14:23:57 +02:00
2018-04-22 15:30:28 +02:00
## Features
### Syntax highlighting
2018-04-26 00:02:53 +02:00
A large number of languages are supported (via Sublime Text definition files):
2018-04-22 15:30:28 +02:00
2018-04-26 00:02:53 +02:00
![Syntax highlighting example](https://imgur.com/rGsdnDe.png)
2018-04-22 15:30:28 +02:00
### Git integration
2018-04-26 00:02:53 +02:00
Additions, modifications and deletions are shown (a la `git diff`):
![Git integration example](https://imgur.com/2lSW4RE)
2018-04-22 16:15:07 +02:00
## Installation
2018-04-26 00:02:53 +02:00
Check out the [Release page](https://github.com/sharkdp/bat/releases) for binary builds and Debian packages.
If you want to build to compile `bat` from source, you need Rust 1.22 or higher.
You can then use `cargo` to build everything:
``` bash
2018-04-22 16:15:07 +02:00
cargo install bat
2018-04-26 00:02:53 +02:00
```
2018-04-22 16:15:07 +02:00
2018-04-26 00:02:53 +02:00
### Get themes and syntax highlighting definitions
``` bash
2018-04-22 16:15:07 +02:00
mkdir -p ~/.config/bat/themes
cd ~/.config/bat/themes
git clone https://github.com/jonschlinkert/sublime-monokai-extended
ln -s "sublime-monokai-extended/Monokai Extended.tmTheme" Default.tmTheme
mkdir -p ~/.config/bat/syntax
cd ~/.config/bat/syntax
git clone https://github.com/sublimehq/Packages/
rm -rf Packages/Markdown
git clone https://github.com/jonschlinkert/sublime-markdown-extended
2018-04-22 16:15:07 +02:00
```