From f6435b5fd3d2d43e8d39ab6a962995e5f4418cca Mon Sep 17 00:00:00 2001 From: Vitaly Date: Tue, 12 Jan 2021 19:06:30 -0800 Subject: [PATCH] Adding build info to the readme --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 142d0066e..fff1f3818 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,22 @@ submodule -- when checking out the repo for the first time make sure you've run ## Dependencies * Protobuf compiler + +# Development + +All of the following commands are enforced for each pull request. + +## Building and testing + +You can buld and test the project using cargo: +`cargo build` +`cargo test` + +## Formatting +To format all code run: +`cargo format --all` + +## Linting +We are using [clippy](https://github.com/rust-lang/rust-clippy) for linting. +You can run it using: +`cargo clippy --all -- -D warnings`