Merge remote-tracking branch 'origin/master' into develop

README.md

@@ -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,57 @@ 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, Arch-based, Fedora-based, or openSUSE-based distro, 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:
+
+```
+./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-to-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
+```
+
+#### Flatpak
+
+If you are using Flatpaks, you will have to add the [Flathub repository](https://flatpak.org/setup/) for your specific distribution, and then, to install it, execute:
+
+##### For Steam flatpak
+```
+flatpak install com.valvesoftware.Steam.VulkanLayer.MangoHud
+```
+To enable MangoHud for all Steam games:
+```
+flatpak override --user --env=MANGOHUD=1 com.valvesoftware.Steam
+```
 
 # Normal usage
 
@@ -56,7 +92,7 @@ MangoHud comes with a config file which can be used to set configuration options
 2. `$HOME/.config/MangoHud/{application_name}.conf`
 3. `$HOME/.config/MangoHud/MangoHud.conf`
 
-The default config file is installed to `$HOME/.config/MangoHud/MangoHud.conf` and will not be overwritten by the script.
+You can find an example config in /usr/share/doc/mangohud
 
 ---
 

build.sh

@@ -53,14 +53,14 @@ dependencies() {
             "Fedora")
                 MANAGER_QUERY="dnf list installed"
                 MANAGER_INSTALL="dnf install"
-                DEPS="{meson,gcc,g++,libX11-devel,glslang,python-mako,mesa-libGL-devel}"
+                DEPS="{meson,gcc,gcc-c++,libX11-devel,glslang,python3-mako,mesa-libGL-devel}"
                 install
 
                 unset INSTALL
                 DEPS="{glibc-devel.i686,libstdc++-devel.i686,libX11-devel.i686}"
                 install
             ;;
-            *"buntu"|"Linux Mint"|"Debian"|"Zorin OS"|"Pop!_OS")
+            *"buntu"|"Linux Mint"|"Debian"|"Zorin OS"|"Pop!_OS"|"elementary OS")
                 MANAGER_QUERY="dpkg-query -s"
                 MANAGER_INSTALL="apt install"
                 DEPS="{gcc,g++,gcc-multilib,g++-multilib,ninja-build,python3-pip,python3-setuptools,python3-wheel,pkg-config,mesa-common-dev,libx11-dev:i386}"
@@ -76,6 +76,11 @@ dependencies() {
                     rm bin/glslangValidator glslang-master-linux-Release.zip
                 fi
             ;;
+            "opensSUSE Leap"|"openSUSE Tumbleweed")
+                MANAGER_QUERY="zypper search"
+                MANAGER_INSTALL="zypper install"
+                DEPS="{gcc-c++,gcc-c++-31bit,meson,libpkgconf-devel,python3-Mako,libX11-devel,libX11-devel-32bit,glslang-devel,libglvnd-devel,libglvnd-devel-32bit,glibc-devel,glibc-devel-32bit,libstdc++-devel,libstdc++-devel-32bit,Mesa-libGL-devel}"
+                install
             "Solus")
                 unset MANAGER_QUERY
                 unset DEPS
@@ -178,6 +183,15 @@ uninstall() {
     rm -fv "/usr/bin/mangohud.x86"
 }
 
+usage() {
+    if test -z $1; then
+        echo "Unrecognized command argument: $a"
+    else
+        echo "$0 requires one argument"
+    fi
+    echo 'Accepted arguments: "pull", "configure", "build", "package", "install", "clean", "uninstall".'
+}
+
 for a in $@; do
     case $a in
         "") build;;
@@ -190,7 +204,11 @@ for a in $@; do
         "uninstall") uninstall;;
         "release") release;;
         *)
-            echo "Unrecognized command argument: $a"
-            echo 'Accepted arguments: "pull", "configure", "build", "package", "install", "clean", "uninstall".'
+            usage
     esac
 done
+
+if [[ -z $@ ]]; then
+    usage no-args
+fi
+