From 0723fb1894e024d1302790d73cb6a5c4e9acb04e Mon Sep 17 00:00:00 2001 From: TheBrokenRail Date: Sat, 23 Apr 2022 23:01:52 -0400 Subject: [PATCH] Improve Docs --- docs/BUILDING.md | 2 +- docs/CHANGELOG.md | 2 +- docs/INSTALL.md | 17 ++++++++++------- docs/README.md | 2 +- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/docs/BUILDING.md b/docs/BUILDING.md index db80f01..a9227d6 100644 --- a/docs/BUILDING.md +++ b/docs/BUILDING.md @@ -15,7 +15,7 @@ * Non-ARM Host Architectures * QEMU User-Mode * Host Architecture Dependencies - * CLient Mode Only + * Client Mode Only * OpenGL ES 1.1 * GLFW * FreeImage diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index 487c808..64f346e 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -1,7 +1,7 @@ # Changelog **2.3.5** -* Rename Some Feature Flags +* Renamed Some Feature Flags * Add `Improved Title Background` Feature Flag (Enabled By Default) * Non-Touch GUI Rework * Make `Full Touch GUI` Feature Flag Disabled By Default diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 2b2582c..de328a0 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -1,5 +1,5 @@ -# Manual Installation -[Download Packages Here](https://jenkins.thebrokenrail.com/job/minecraft-pi-reborn/job/master/lastSuccessfulBuild/artifact/out/) +# Installation +Download packages [here](https://jenkins.thebrokenrail.com/job/minecraft-pi-reborn/job/master/lastSuccessfulBuild/artifact/out/). ## Picking A Package @@ -9,10 +9,13 @@ minecraft-pi-reborn-_X.Y.Z_ ``` ### Picking A Variant -* ``client``: Client mode, use this if you want to play MCPI -* ``server``: Server mode, use this if you want to host a dedicated MCPI server +* ``client``: Client mode, use this if you want to play MCPI. +* ``server``: Server mode, use this if you want to host a dedicated MCPI server. ### Picking An Architecture -* ``amd64``: x86_64, use this if you are using a device with an AMD or Intel processor -* ``armhf``: ARM 32-Bit, use this if you are using an ARM device (like a Raspberry Pi) -* ``arm64``: ARM 64-Bit, ``armhf`` but for 64-bit devices +* ``amd64``: x86_64, use this if you are using a device with an AMD or Intel processor. +* ``armhf``: ARM 32-Bit, use this if you are using an ARM device (like a Raspberry Pi). +* ``arm64``: ARM 64-Bit, ``armhf`` but for 64-bit devices. + +## Running +Follow [these](https://docs.appimage.org/introduction/quickstart.html#how-to-run-an-appimage) instructions. diff --git a/docs/README.md b/docs/README.md index a62d74f..e64f003 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,5 +1,5 @@ # Documentation -* [View Manual Installation](INSTALL.md) +* [View Installation](INSTALL.md) * [View Overriding Assets](OVERRIDING_ASSETS.md) * [View Dedicated Server](DEDICATED_SERVER.md) * [View Credits](CREDITS.md)