liangsheng8708
/
ruffle
mirror of https://mirror.ghproxy.com/https://github.com/ruffle-rs/ruffle.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update README

This commit is contained in:
Mike Welsh 2019-04-27 23:26:04 -07:00
parent ee64cc77bc
commit 0d9d5fe57d
1 changed files with 15 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
README.md
View File

@ -1,53 +1,22 @@
# 🦀🕸️ `wasm-pack-template` #[Fluster 😳](https://github.com/Herschel/fluster)
A template for kick starting a Rust and WebAssembly project using Fluster is an Adobe Flash Player emulator written in Rust.
[`wasm-pack`](https://github.com/rustwasm/wasm-pack).
[**📚 Read this template tutorial! 📚**][template-docs] ## Structure
This template is designed for compiling Rust libraries into WebAssembly and - `core` contains the core emulator and common code
publishing the resulting package to NPM. - `desktop` contains the desktop client (uses `glium`)
- `web` contains the web client (uses `wasm-bindgen`)
Be sure to check out [other `wasm-pack` tutorials online][tutorials] for other ## License
templates and usages of `wasm-pack`.
[tutorials]: https://rustwasm.github.io/docs/wasm-pack/tutorials/index.html Licensed under either of
[template-docs]: https://rustwasm.github.io/docs/wasm-pack/tutorials/npm-browser-packages/index.html * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
at your option.
## 🚴 Usage ### Contribution
### 🐑 Use `cargo generate` to Clone this Template Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you shall be dual licensed as above, without any
[Learn more about `cargo generate` here.](https://github.com/ashleygwilliams/cargo-generate) additional terms or conditions.
```
cargo generate --git https://github.com/rustwasm/wasm-pack-template.git --name my-project
cd my-project
```
### 🛠️ Build with `wasm-pack build`
```
wasm-pack build
```
### 🔬 Test in Headless Browsers with `wasm-pack test`
```
wasm-pack test --headless --firefox
```
### 🎁 Publish to NPM with `wasm-pack publish`
```
wasm-pack publish
```
## 🔋 Batteries Included
* [`wasm-bindgen`](https://github.com/rustwasm/wasm-bindgen) for communicating
between WebAssembly and JavaScript.
* [`console_error_panic_hook`](https://github.com/rustwasm/console_error_panic_hook)
for logging panic messages to the developer console.
* [`wee_alloc`](https://github.com/rustwasm/wee_alloc), an allocator optimized
for small code size.