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

35 lines
1.0 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 syntax highlighting and Git integration.*
6 years ago
## Features
### Syntax highlighting
6 years ago
`bat` supports a large number of programming and markup languages (see below):
6 years ago
![Syntax highlighting example](https://imgur.com/rGsdnDe.png)
### Git integration
6 years ago
`bat` communicates with `git` to show modifications with respect to the index (see left side bar):
6 years ago
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.
### From source
6 years ago
If you want to build to compile `bat` from source, you need Rust 1.22 or higher.
Make sure that you have the devel-version of libopenssl installed (see instructions
[here](https://github.com/sfackler/rust-openssl)). You can then use `cargo` to build everything:
``` bash
cargo install bat
6 years ago
```