From bc4ecc21ab7f15d8047ec8ecedea4bc133f4d58d Mon Sep 17 00:00:00 2001 From: thilo-behnke Date: Sun, 3 Jul 2022 15:10:49 +0200 Subject: [PATCH] docs/create-readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..84b4dfb --- /dev/null +++ b/README.md @@ -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