From 4d3f1c63a2a8509ebba20b6065accb97e77fbb67 Mon Sep 17 00:00:00 2001 From: Nick Fitzgerald Date: Tue, 19 Jun 2018 11:49:34 -0700 Subject: [PATCH] Point to the guide's contributing section instead of CONTRIBUTING.md --- CONTRIBUTING.md | 40 ++-------------------------------------- README.md | 5 +++-- 2 files changed, 5 insertions(+), 40 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ca5ed2cf0..f3df55046 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,40 +1,4 @@ # 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. Make sure you have node >= 8 installed, - as that is when WebAssembly support was introduced. [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). - - Once `yarn` is installed, run it in the top level directory: - - ``` - yarn - ``` - - Finally, you can run the tests with `cargo`: - - ``` - cargo test - ``` +See the ["Contributing" section of the `wasm-bindgen` +guide](https://rustwasm.github.io/wasm-bindgen/contributing.html). diff --git a/README.md b/README.md index 741bc0b2e..a66abb55e 100644 --- a/README.md +++ b/README.md @@ -69,10 +69,11 @@ at your option. ## Contribution -[See `CONTRIBUTING.md` for hacking!][contributing] +**[See the "Contributing" section of the guide for information on +hacking on `wasm-bindgen`!][contributing]** Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. -[contributing]: (https://github.com/rustwasm/wasm-bindgen/blob/master/CONTRIBUTING.md) +[contributing]: https://rustwasm.github.io/wasm-bindgen/contributing.html