You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
bat/README.md

47 lines
1.3 KiB
Markdown

6 years ago
# bat
6 years ago
[![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)
6 years ago
*A cat(1) clone with wings.*
6 years ago
## Features
### Syntax highlighting
6 years ago
A large number of languages are supported (via Sublime Text definition files):
6 years ago
![Syntax highlighting example](https://imgur.com/rGsdnDe.png)
### Git integration
6 years ago
Additions, modifications and deletions are shown (a la `git diff`):
6 years ago
![Git integration example](https://i.imgur.com/2lSW4RE.png)
## Installation
6 years ago
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
cargo install bat
6 years ago
```
6 years ago
### Get themes and syntax highlighting definitions
``` bash
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
```