From abada4f4067e7ff7630b090a03d93aa90aaf9c33 Mon Sep 17 00:00:00 2001 From: Liam Dawe Date: Sat, 14 Mar 2020 15:34:37 +0000 Subject: [PATCH] update readme based on new command Adjust the Normal use text, to account for OpenGL and the new command. --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2da94ada..91911856 100644 --- a/README.md +++ b/README.md @@ -34,11 +34,19 @@ If you are running an Ubuntu-like distribution, Fedora, or Arch, the build scrip # Normal usage -To enable the MangoHud Vulkan overlay layer, run : +To enable the MangoHud overlay layer for 64bit Vulkan and OpenGL, run : -`MANGOHUD=1 /path/to/my_vulkan_app` +`mangohud /path/to/app` -Or alternatively, add `MANGOHUD=1` to your shell profile. +Or + +`mangohud.x86 /path/to/app` for 32bit OpenGL + +For Steam games, you can add this as a launch option: + +`mangohud %command%` + +Or alternatively, add `MANGOHUD=1` to your shell profile (Vulkan only). ## Hud configuration