rustwasm/wasm-bindgen
1
0
Fork 0
mirror of https://github.com/rustwasm/wasm-bindgen.git synced 2024-12-29 13:06:06 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #84 from ashleygwilliams/prereq-readme

Browse Source 
doc(contributing): add a contributing.md
This commit is contained in:
Alex Crichton 2018-03-29 13:19:38 +02:00 committed by GitHub
commit 6347685976
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
CONTRIBUTING.md Normal file
View File

@ -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).