README.md 1.44 KB
Newer Older
Rahix's avatar
Rahix committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
# 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.