summaryrefslogtreecommitdiff
path: root/readme.md
diff options
context:
space:
mode:
authormetamuffin <metamuffin@disroot.org>2024-08-12 11:35:52 +0200
committermetamuffin <metamuffin@disroot.org>2024-08-12 11:35:52 +0200
commit33f46bf3637ab2bec3dc0c84c7d6d29c0787f658 (patch)
treef9c4fdb838c183e2c0db16d145a4624b8732e1da /readme.md
parent66e681c18e13b83a4d9e3836e72bbf7bc374f272 (diff)
downloadhurrycurry-33f46bf3637ab2bec3dc0c84c7d6d29c0787f658.tar
hurrycurry-33f46bf3637ab2bec3dc0c84c7d6d29c0787f658.tar.bz2
hurrycurry-33f46bf3637ab2bec3dc0c84c7d6d29c0787f658.tar.zst
reword readme again
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md22
1 files changed, 12 insertions, 10 deletions
diff --git a/readme.md b/readme.md
index 1f5b80fd..147aad18 100644
--- a/readme.md
+++ b/readme.md
@@ -6,18 +6,20 @@ The protocol is documented in [protocol.md](protocol.md).
## Installation
-The pre-built server and client are available on [itch.io](https://metamuffin1.itch.io/hurrycurry) and the [AUR](https://aur.archlinux.org/packages/hurrycurry-client).
+The installation methods for end-users are listed on the
+[game's website](https://hurrycurry.metamuffin.org/).
-The client is also available on [flathub](https://flathub.org/apps/org.metamuffin.hurrycurry.client).
-
-For information about building from source, see the instructions below.
+For information about building from source, see the instructions for the
+individual components below.
## Translation
-If you want to help translate the project, you can use the [weblate](https://translate.codeberg.org/projects/hurrycurry/client/).
-All help is appreciated.
+If you want to help translate the project, you can use the
+[weblate](https://translate.codeberg.org/projects/hurrycurry/client/). All help
+is appreciated.
-If your language is not available on weblate, please [open an issue](https://codeberg.org/hurrycurry/hurrycurry/issues/new).
+If your language is not available on weblate, please
+[open an issue](https://codeberg.org/hurrycurry/hurrycurry/issues/new).
## Client
@@ -50,9 +52,9 @@ make test-client
### Usage
-- Ensure the `data` directory is available **in** either the process working
- directory of the server or /usr/share/hurrycurry (or similar). Running the
- server in the source folder should work.
+- Ensure the `data` directory is available **contained within** (not is) either
+ the process working directory of the server or in /usr/share/hurrycurry (or
+ similar). Running the server in the source folder should work.
- Run the server: `./target/release/hurrycurry-server`
## Pixel Client