docs/create-readme

This commit is contained in:
thilo-behnke
2022-07-03 15:10:49 +02:00
committed by Thilo Behnke
parent f1f97ef243
commit b16bf54699

17
README.md Normal file
View File

@@ -0,0 +1,17 @@
# wasm-pong
Implementation of Pong with local and online coop.
The game is modelled as a series of events, so that other players/observers can easily join a game by consuming the events.
# How to run
- Complete: `./run-server.sh`
- Dev: `./run-server.dev.sh`
- For dev the rust server and Svelte client can be started manually to allow debugging
# Implementation
- Game engine is implemented in wasm/rust
- Web GUI is implemented in Svelte
- Web server is implemented in rust/hyper
- Game events are persisted in kafka