From 9c1e546cde1697009d9b5af4cb9c9cc37d27be32 Mon Sep 17 00:00:00 2001
From: 20PercentRendered <32398752+20PercentRendered@users.noreply.github.com>
Date: Sat, 30 Apr 2022 13:50:26 +0300
Subject: [PATCH] update build and usage instructions

---
 README.md | 32 +++++++++++++++++++++-----------
 1 file changed, 21 insertions(+), 11 deletions(-)

diff --git a/README.md b/README.md
index ddeb4f3..97681ae 100644
--- a/README.md
+++ b/README.md
@@ -2,26 +2,36 @@
 CreamApi(dlc unlocker) for Linux.
 
 ## Support
-A lot of the code is based on hookey, which means this should work for HOI4 but other games are unknown. Maybe don't try it on VAC-secure games. Probably doesn't work with wine/proton.
+This should work for any linux native steam title that doesn't block LD_PRELOAD. However not all games will be visible in the launcher. This is due to change (launcher rewrite)
+## Tested games
+ - Hearts Of Iron IV
+ - Stellaris 
 
 ## Usage
-First, clone project recursively. 
-`git clone https://github.com/20PercentRendered/creamlinux --recursive`
-1. build the project with `sh build.sh`.
+First, clone the project recursively:
+```
+git clone https://github.com/20PercentRendered/creamlinux --recursive
+```
+1. build the project like any standard CMake project:
+```
+mkdir build
+cd build
+cmake ..
+make
+```
 
-2. Copy build/lib folder contents to the game folder.
-3. Then set steam launch params: `./cream.sh %command%`
-4. If you copied an existing cream_api.ini, make sure the line endings are set to linux line endings, otherwise this will not work (just open it and save it again)
+2. Copy `build/lib` folder contents to the game folder.
+3. Then set the game's steam launch params to `./cream.sh %command%`.
+4. If you copied an existing `cream_api.ini`, make sure the line endings are set to linux line endings, otherwise this will not work (just open it and save it again)
 
-When the dialog pops up, it will look a bit strange due to steam's bundled deps being ancient (gtk2 is seriously out of date). If you are running on Arch, you can run steam-native.
+When the dialog pops up, it will look a bit strange due to steam's bundled deps being ancient (gtk2 and zenity).
 
-
-If you want to load cream_api.ini from a separate path, specify the path with CREAM_CONFIG_PATH;
+If you want to load `cream_api.ini` from a separate path, specify the path with `CREAM_CONFIG_PATH` in the launch options.
 
 ## Credits
 [pulzed](https://github.com/pulzed) for [mINI](https://github.com/pulzed/mINI)(ini.h)
 
-Valve for steamworks
+[Valve](https://www.valvesoftware.com/) for [steamworks](https://partner.steamgames.com/)
 
 [gabime](https://github.com/gabime) for [spdlog](https://github.com/gabime/spdlog)