From 28e1d0e613833f87681df8e341a9ad5e76a8e28b Mon Sep 17 00:00:00 2001 From: sharkdp Date: Tue, 28 Aug 2018 21:03:03 +0200 Subject: [PATCH] Add development section to README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index 06d88da9..08c68857 100644 --- a/README.md +++ b/README.md @@ -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: