1
0
mirror of https://github.com/sharkdp/bat.git synced 2024-10-06 02:41:06 +01:00
bat/README.md

35 lines
1.0 KiB
Markdown
Raw Normal View History

2018-04-21 13:23:57 +01:00
# bat
2018-04-22 15:08:49 +01: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-30 12:10:50 +01:00
*A cat(1) clone with syntax highlighting and Git integration.*
2018-04-21 13:23:57 +01:00
2018-04-22 14:30:28 +01:00
## Features
### Syntax highlighting
2018-04-25 23:11:10 +01:00
`bat` supports a large number of programming and markup languages (see below):
2018-04-22 14:30:28 +01:00
2018-04-25 23:02:53 +01:00
![Syntax highlighting example](https://imgur.com/rGsdnDe.png)
2018-04-22 14:30:28 +01:00
### Git integration
2018-04-25 23:12:49 +01:00
`bat` communicates with `git` to show modifications with respect to the index (see left side bar):
2018-04-25 23:02:53 +01:00
2018-04-25 23:03:25 +01:00
![Git integration example](https://i.imgur.com/2lSW4RE.png)
2018-04-22 15:15:07 +01:00
## Installation
2018-04-25 23:02:53 +01:00
Check out the [Release page](https://github.com/sharkdp/bat/releases) for binary builds and Debian packages.
### From source
2018-04-25 23:02:53 +01:00
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
2018-04-22 15:15:07 +01:00
cargo install bat
2018-04-25 23:02:53 +01:00
```