From 0a2c83e48c98eb05384dc3905178fbea59147b75 Mon Sep 17 00:00:00 2001
From: 20PercentRendered <32398752+20PercentRendered@users.noreply.github.com>
Date: Sat, 16 Apr 2022 22:09:29 +0300
Subject: [PATCH] Update README.md

---
 README.md | 19 ++++++++++++++-----
 1 file changed, 14 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 04bb809..5fb0182 100644
--- a/README.md
+++ b/README.md
@@ -1,17 +1,26 @@
 # Creamlinux
-CreamApi for Linux.
+CreamApi(dlc unlocker) for Linux.
 
 ## BIG NOTICE PLEASE READ
-This has primarily been made for my personal use, however I have decided to open source it. A lot of the code is based on [hookey](https://github.com/goddessfreya/hookey). One of the goals of this project was being able to play internet multiplayer with dlcs. The code is pretty janky, but it works. This should work for most games, but you'll need to LD_PRELOAD manually, or add the game binary to the supported games array. Maybe don't try it on VAC-secure games though. Also, keep in mind this was written with HOI4 in mind. THIS WILL NOT WORK THROUGH WINE/PROTON
+This has primarily been made for my personal use, however I have decided to open source it. A lot of the code is based on hookey, which means this will work for HOI4 but other games are unknown. Maybe don't try it on VAC-secure games. THIS WILL NOT WORK THROUGH WINE/PROTON (maybe)
 
 ## Usage
-First, build the project with `sh build.sh`.
+1. build the project with `sh build.sh`.
 
-Then, copy build/lib folder contents to the game folder. Then set steam launch params: `./cream.sh %command%`
+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)
 
-This will open a dialog that allows you to launch the game and edit cream_api.ini.
+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.
+
+
+If you want to load cream_api.ini from a separate path, specify the path with CREAM_CONFIG_PATH;
 
 ## Credits
 mINI for ini.h
 
 Valve for steamworks
+
+[gabime](https://github.com/gabime) for [spdlog](https://github.com/gabime/spdlog)
+
+goddeysfreya for [hookey](https://github.com/goddessfreya/hookey)