From 4bebb3cbe4a0206d44cc9cc740fa066485955275 Mon Sep 17 00:00:00 2001 From: Brian Grinstead Date: Fri, 16 Dec 2016 11:57:18 -0800 Subject: [PATCH] Include instructions for building and testing with cargo --- README.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/README.md b/README.md index 43789e8e..cb43cae2 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,21 @@ This project is very new, so we'll probably revise these guidelines. Please comment on an issue before putting significant effort in if you'd like to contribute. +## Building + +Right now this code is located on a branch, so you first need to `git checkout rust`. To build and test the project, we are using [Cargo](https://crates.io/install). + +To build use + +```` +cargo build +```` + +To run tests use: + +```` +cargo test +```` ## License