From 3475b19e526eee1c53a3b965431d8cf407362a63 Mon Sep 17 00:00:00 2001 From: ModZero Date: Sun, 23 Aug 2020 01:17:36 +0200 Subject: [PATCH] Add a readme --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..195312b --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +# Carrier Signal Lost + +Mostly just a toy for checking out the cross-section of Rust web development, +Legion ECS and some physics stuff. If you're not on my [private Gitea][1] then +this is just a mirror and pull requests won't work. + +## Running + +Just do `cargo run`. There will be a websocket at `ws://localhost:3030/state`. +To actually have something (questionably) useful, check out the [client][2] + +[1]: https://fullspectrumconfidence.modzero.xyz/gitea/modzero/carrier-signal +[2]: https://fullspectrumconfidence.modzero.xyz/gitea/modzero/carrier-signal-client