Update README.md
Separated #build and #install
Properly formatted
Fixed some Arch stuff
Changed "Packaging Status" to "Pre-packaged binaries" to make more sense
@@ -7,7 +7,7 @@ A modification of the Mesa Vulkan overlay. Including GUI improvements, temperatu
# Installation
-If you do not wish to compile anything, simply download the file under Releases, extract it, and run `./mangohud-setup.sh install` from within the extracted folder.
+## Build
If you wish to compile MangoHud to keep up to date with any changes - first clone this repository and cd into it:
@@ -16,21 +16,44 @@ git clone --recurse-submodules https://github.com/flightlessmango/MangoHud.git
cd MangoHud
```
-Then simply run the following commands:
+To build it, execute:
-`./build.sh build`
-<br>`./build.sh package`
-<br>`sudo ./build.sh install`
+```
+./build.sh build
+./build.sh package
+```
----
+**NOTE: If you are running an Ubuntu-based, Fedora, or Arch-based, the build script will automatically detect and prompt you to install missing build dependencies. If you run into any issues with this please report them!**
+
+Once done, proceed to the [installation](#source).
+
+## Install
+
+### Source
+
+If you have compiled MangoHud from source, to install it, execute:
+
+```
+sudo ./build.sh install
+```
+
+### Pre-packaged binaries
+
+#### GitHub releases
-If you are running an Ubuntu-like distribution, Fedora, or Arch, the build script will automatically detect and prompt you to install missing build dependencies. If you run into any issues with this please report them!
+If you do not wish to compile anything, simply download the file under [Releases](https://github.com/flightlessmango/MangoHud/releases), extract it, and run `./mangohud-setup.sh install` from within the extracted folder.
-## Packaging status
+#### Arch-based distributions
-[Fedora](https://src.fedoraproject.org/rpms/mangohud): `sudo dnf install mangohud`
+If you are using an Arch-based distribution, install [`mangohud`](https://aur.archlinux.org/packages/mangohud/) and [`lib32-mangohud`](https://aur.archlinux.org/packages/lib32-mangohud/) with your favourite AUR helper. [`mangohud-git`](https://aur.archlinux.org/packages/mangohud-git/) and [`lib32-mangohud-git`](https://aur.archlinux.org/packages/lib32-mangohud-git/) are also available on the AUR if you want the up do date version of MangoHud.
-[Arch](https://aur.archlinux.org/packages/mangohud): Install `mangohud` and `lib32-mangohud` with your favourite AUR helper. `mangohud-git` is also available on the AUR.
+#### Fedora
+
+If you are using Fedora, to install the [MangoHud](https://src.fedoraproject.org/rpms/mangohud) package, execute:
+
+```
+sudo dnf install mangohud
+```
# Normal usage
