diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..e2d8f608 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing + +This document contains instructions on how to get this project up and running. +For more information on the architecture, design, and goals of this project +please checkout [`DESIGN.md`](DESIGN.md). + +## Prerequisites + +1. Rust Nightly. [Install Rust]. Once Rust is installed, run + + ``` + rustup default nightly + ``` + +[install Rust]: https://www.rust-lang.org/en-US/install.html + +2. The tests for this project use Node. [Install Node]. + +[Install Node]: https://nodejs.org/en/ + +3. The tests for this project also use yarn, a package manager for Node. To install yarn, run: + + ``` + npm install yarn -g + ``` + + ... or follow other platform-specific instructions [here](https://yarnpkg.com/en/docs/install). +