Add development section to README

This commit is contained in:
sharkdp 2018-08-28 21:03:03 +02:00
parent d11839ad03
commit 28e1d0e613

View File

@ -225,6 +225,27 @@ script as a wrapper, for example:
less --tabs 4 -RF "$@"
```
## Development
```bash
# Recursive clone to retrieve all submodules
git clone --recursive https://github.com/sharkdp/bat
# Build (debug version)
cd bat
cargo build
# Run unit tests and integration tests
cargo test
# Install (release version)
cargo install
# Build a bat binary with modified syntaxes and themes
bash assets/create.sh
cargo install -f
```
## Project goals and alternatives
`bat` tries to achieve the following goals: