summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorsharkdp <davidpeter@web.de>2018-08-28 21:03:03 +0200
committersharkdp <davidpeter@web.de>2018-08-28 21:03:03 +0200
commit28e1d0e613833f87681df8e341a9ad5e76a8e28b (patch)
tree563490b2a2a3daee8414492071b892146994fd09
parentd11839ad030222423a9a754477d2a47c48a0f433 (diff)
Add development section to README
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
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: