From 1ae2c8e16076495a06c37a80fc2b8f426fe581fe Mon Sep 17 00:00:00 2001 From: DavidOConnor Date: Wed, 12 Dec 2018 01:08:07 -0500 Subject: [PATCH] Changed wording of readme for clarity --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4e0d136..0d98f62 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,7 @@ # Seed Quickstart -To get started, clone this repo, and make the following changes: - -- Rename your crate in `Cargo.toml` (The `name` field under `[Package]`) - -- Replace both occurances of `appname` (`/appname.js` and `/appname.wasm`) in `index.html` with your -crate's name. - -- Make the same replacement in either `build.sh`, or `build.ps1`, depending on your -operating system (`.sh` for Linux, `.ps1` for Windows). You may delete the other one. - +**To get started:** +- Clone this repo - If you don't have Rust installed, nightly set up, and wasm-bindgen, [Download it](https://www.rust-lang.org), and run the following commands: @@ -21,5 +13,14 @@ operating system (`.sh` for Linux, `.ps1` for Windows). You may delete the other `cargo +nightly install wasm-bindgen-cli` - - Run `build.sh` or `build.ps1`, then open `index.html` in a web browser, or use a local server. - (Opening the file directly may not work in some browsers.) \ No newline at end of file + - Run `build.sh` or `build.ps1`, then open `index.html` in a web browser, or use a local server. (Opening the file directly may not work in some browsers.) + + +Once you rename the crate in `Cargo.toml` (The `name` field under `[Package]`), make the +following changes: + +- Replace both occurances of `appname` (`/appname.js` and `/appname.wasm`) in `index.html` with your crate's name. + +- Make the same replacement in either `build.sh`, or `build.ps1`, depending on your +operating system. You may delete the other one. +