diff --git a/README.md b/README.md index 15f90bbd..8a8fd12b 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,9 @@ A modification of the Mesa Vulkan overlay. Including GUI improvements, temperatu # Installation -First, clone this repository and cd into it: +If you do not wish to compile anything, simply download the file under Releases, extract it, and run `./install.sh` from within the extracted folder. + +If you wish to compile MangoHud to keep up to date with any changes - first clone this repository and cd into it: ``` git clone --recurse-submodules https://github.com/flightlessmango/MangoHud.git @@ -20,6 +22,10 @@ Then simply run the following command: This will build and copy `libMangoHud.so` & `libMangoHud32.so` to `$HOME/.local/share/MangoHud`, as well as copying the required Vulkan layer configuration files. +--- + +If you are running an Ubuntu-like distrobution, Fedora, or Arch, the build script will automatically detect and prompt you to install missing build dependencies. If you run in to any issues with this please report them! + # Normal usage To enable the MangoHud Vulkan overlay layer, run : @@ -69,12 +75,3 @@ These filenames will be used as the legend in the graph. #### Log uploading walkthrough ![](assets/log_upload_example.gif) - -# Notable changes - -- Removed hud decoration [90a2212](https://github.com/flightlessmango/mesa/commit/90a2212055a8047d46d0220d5fdc30a76900aaed) -- Changed frametime graph to Lines instead of Histogram [e40533b](https://github.com/flightlessmango/mesa/commit/e40533b7f46858e5b9f08829e789277b2364d5d1) -- Set static min/max ms on frametime graph to act like Afterburners graph [df5238f](https://github.com/flightlessmango/mesa/commit/df5238f990218f5d6e698d572b05ddd19e52b108) -- Added CPU/GPU usage (Only Nvidia and AMD) -- Changed font to UbuntuMono-Bold [73f0aa9](https://github.com/flightlessmango/mesa/commit/73f0aa94d382365205a4a4128d82208315b0b190) -- Increased hud font size [b7d238b](https://github.com/flightlessmango/mesa/commit/b7d238b07eb82153f272d34bf7d1353b701f32e0) diff --git a/build.sh b/build.sh index c4f1000e..2ba12740 100755 --- a/build.sh +++ b/build.sh @@ -44,7 +44,7 @@ dependencies() { DEPS="{glibc-devel.i686,libstdc++-devel.i686,libX11-devel.i686}" install ;; - "Ubuntu"|"Linux Mint"|"Debian") + *"buntu"|"Linux Mint"|"Debian") MANAGER_QUERY="dpkg-query -l" 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}"