Commit dcf818fc authored by Rahix's avatar Rahix 🦀
Browse files

Add README and a license

parent fbdb2636
This diff is collapsed.
......@@ -2,6 +2,7 @@
name = "rc3-muccc"
version = "0.1.0"
authors = ["Rahix <rahix@rahix.de>"]
license = "GPL-3.0-or-later"
edition = "2018"
autobins = false
......
# What is this?
This will at some point be a game, written in Rust, using WebAssembly.
# Hacking
- [Build Dependencies](#build-dependencies)
- [Development Environment](#development-environment)
- [Project Structure](#project-structure)
## Build Dependencies
Not quite sure what the dependencies really are, please add
as you find out:
- `rustc` & `cargo` (duh ... best install them via [`rustup`])
- [`wasm-pack`]
- `npm`
- (optional: [`cargo-watch`])
[`wasm-pack`]: https://github.com/rustwasm/wasm-pack
[`rustup`]: https://rustup.rs/
[`cargo-watch`]: https://github.com/passcod/cargo-watch
## Development Environment
Open two shell sessions, one for the rust build and one for the webpack dev
server:
```bash
# For the webpack dev server:
cd www/
npm run start
# For Rust:
cargo watch -s "wasm-pack build" --watch src
# or, if you don't use cargo-watch, just run
wasm-pack build
```
Then point your browser to `http://localhost:8080` and start hacking! The
website will automatically reload when any changes are done to the web sources
(`www/src/`) or the Rust sources (`src/`).
## Project Structure
*TODO*
---
# License
Licensed under the GNU General Public License v3.0 ([COPYING](COPYING) or
<https://www.gnu.org/licenses/gpl-3.0-standalone.html>).
## Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, shall be licensed as above, without any
additional terms or conditions.
......@@ -8,7 +8,7 @@
"start": "webpack-dev-server"
},
"author": "Rahix <rahix@rahix.de>",
"license": "TODO",
"license": "GPL-3.0-or-later",
"dependencies": {
"rc3-muccc": "file:../pkg"
},
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment