From 10ef9cc31c82ada3625eab232d8c4b81a1356f1a Mon Sep 17 00:00:00 2001 From: metamuffin Date: Sun, 13 Jul 2025 16:44:00 +0200 Subject: Split off component-specific content into seperate readme files --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 README.md (limited to 'README.md') diff --git a/README.md b/README.md new file mode 100644 index 00000000..1e9e2e13 --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# Hurry Curry! + +A cooperative 3D multiplayer game about cooking. + +## Installation + +The installation methods for end-users are listed on the +[game's website](https://hurrycurry.metamuffin.org/). For information about +building from source, see the instructions below. + +## Translation + +If you want to help translate the project, you can use the +[weblate](https://translate.codeberg.org/engage/hurrycurry/). All help is +appreciated. + +## Building / Development / Documentation + +The game is composed of individual components each has its own readme file and +convinience make target. + +- [Client](./client/README.md) +- [Server](./server/README.md) +- [Data](./data/README.md) +- [Book](./book/README.md) +- [Test Client](./data/README.md) + +The game protocol is outlined in [protocol.md](./protocol.md). + +## Contributing + +Contributions are appreciated, just open issues or PRs for the things you think +could be improved. + +For discussion regarding development, feel free to join our matrix room: +[#hurrycurry:metamuffin.org](https://matrix.to/#/#hurrycurry:metamuffin.org). + +## License + +AGPL-3.0-only; See [COPYING](./COPYING). -- cgit v1.2.3-70-g09d2