on master help sign in
Add development section to README
commit28e1d0e613833f87681df8e341a9ad5e76a8e28b authorsharkdp <davidpeter@web.de> dateTue 28 Aug 2018, 21:03 (8 years ago) parentd11839a
1 file changed+21
README.md+21
README.md+21
@@ -225,6 +225,27 @@ script as a wrapper, for example:
225225less --tabs 4 -RF "$@"
226226```
227227
228+## Development
229+
230+```bash
231+# Recursive clone to retrieve all submodules
232+git clone --recursive https://github.com/sharkdp/bat
233+
234+# Build (debug version)
235+cd bat
236+cargo build
237+
238+# Run unit tests and integration tests
239+cargo test
240+
241+# Install (release version)
242+cargo install
243+
244+# Build a bat binary with modified syntaxes and themes
245+bash assets/create.sh
246+cargo install -f
247+```
248+
228249## Project goals and alternatives
229250
230251`bat` tries to achieve the following goals: