docs: Update README with build instructions

Add simple build instructions to README for both desktop and web.
This commit is contained in:
Mike Welsh 2019-05-16 10:10:32 -07:00 committed by GitHub
parent 6673527b0a
commit b5ef3cb4ea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions

View File

@ -2,6 +2,21 @@
Ruffle is an Adobe Flash Player emulator written in Rust.
## Building
[Follow the official guide](https://www.rust-lang.org/tools/install) to install Rust for your platform.
### Desktop
* `cargo build --package=ruffle_desktop -- test.swf`
### Web
* Install [Node.js](https://nodejs.org/en/)
* Install [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
* `npm run serve --prefix web`
* Load indicated page in browser (usually [http://localhost:8080])
## Structure
- `core` contains the core emulator and common code