From 54b40774365c8ed27c53e7eb3ffea0b47baa2082 Mon Sep 17 00:00:00 2001 From: Katharina Fey Date: Sat, 20 Feb 2021 15:36:30 +0100 Subject: [PATCH] Updating READMEs --- README.md | 38 +++++++++++++++++++++++++++++--------- games/rstnode/README.md | 19 +++++++++++++++---- 2 files changed, 44 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index c67a0e9c48e..e689da07094 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@
- +

kookienomicon

@@ -15,14 +15,34 @@ Be warned though, there's software ahead ~✨ Following is an overview of components in this repository. -| Directory | Description | -|-------------|--------------------------------------------------------------------------------| -| apps | Applications (graphical and command-line) meant for end-users | -| development | Libraries and specific tools primarily meant to be used by software developers | -| docs | Documentation for the kookienomicon | -| infra | Personal infrastructure projects (namely `libkookie` & my website) | -| junkyard | Projects I've abandoned and that are considered read-only archives | -| licenses | Set of license texts in use by projects in this repository | +| Directory | Description | +|------------------------------|--------------------------------------------------------------------------------| +| [apps](./apps) | Applications (graphical and command-line) meant for end-users | +| [development](./development) | Libraries and specific tools primarily meant to be used by software developers | +| [docs](./docs) | Documentation for the kookienomicon | +| [games](./games) | Free software games and game tools | +| [infra](./infra) | Personal infrastructure projects (namely `libkookie` & my website) | +| [junkyard](./junkyard) | Projects I've abandoned and that are considered read-only archives | +| [licenses](./licenses) | Set of license texts in use by projects in this repository | +| [nix](./nix) | Nix build files and utilities | +| [prototypes](./prototypes) | Small experiments that don't fit anywhere else | + + +## Contributing + +Because the kookienomicon is hosted on a platform that doesn't allow +public signup, contributing via PRs is not possible. Instead, if you +want to provide an update to any of the projects hosted in this +archive, you can do so via e-mail. You can either send a [set of +patches] to my [public inbox], or host your changes somewhere and send +me an e-mail [pull request]. + +For additional help on how to set up git's e-mail tools go [here]. + +[set of patches]: https://spacekookie.de/blog/collaborating-with-git-send-email/ +[public inbox]: https://lists.sr.ht/~spacekookie/public-inbox +[pull request]: https://www.git-scm.com/docs/git-request-pull +[here]: https://git-send-email.io/ ## Working with a large repo diff --git a/games/rstnode/README.md b/games/rstnode/README.md index 033242bc816..df6c76b780f 100644 --- a/games/rstnode/README.md +++ b/games/rstnode/README.md @@ -1,12 +1,13 @@
- +
A real-time strategy game about capturing computers on a network, -building defence, attack, and research clusters. Primarily -multiplayer focussed with some bad AIs and a single player story. -Free software and made with love 💟. +building defence-, attack-, and research-clusters. + +Primarily multiplayer focussed with some bad AIs and a single player +story. Free software and made with love 💟. ## How to build @@ -20,6 +21,16 @@ installed on your computer: If you want to hack on the game, check out the developer manual in [`docs/devel`](docs/devel) +[1]: https://doc.rust-lang.org/cargo/getting-started/installation.html +[2]: https://nixos.org/nix + + ## How to play Check out the player manual in [`docs/player`](docs/devel) + + +## Test server + +There is a RST Node test server hosted at +`hyperion.kookie.space:121212`.