From 929474661b2ef63fb2fa37577ea2cf69cb0ba784 Mon Sep 17 00:00:00 2001
From: otavepto <153766569+otavepto@users.noreply.github.com>
Date: Sun, 31 Dec 2023 01:55:34 +0200
Subject: [PATCH] added readme for resources folder

---
 resources/README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 resources/README.md

diff --git a/resources/README.md b/resources/README.md
new file mode 100644
index 00000000..a446619a
--- /dev/null
+++ b/resources/README.md
@@ -0,0 +1,16 @@
+This directory contains additional resources used during build.  
+
+* The folder [win](./win/) contains the resources added to the .dll/.exe binaries,  
+  these include version info and an immitation of any extra resources found in the original .dll/.exe.  
+  
+  These resources are built using Microsoft's resourec compiler `rc.exe` during the build process,  
+  and the output files are stored in `build\tmp\win\rsrc` as `*.res`.  
+
+  These resources are later passed to the compiler `cl.exe` as any normal `.cpp` or `.c` file:  
+  ```bash
+  cl.exe myfile.cpp myres.res -o myout.exe
+  ```
+    * [api](./win/api/): contains an immitation of the resources found in `steam_api(64).dll`
+    * [client](./win/client/): contains an immitation of the resources found in `steamclient(64).dll`
+    * [launcher](./win/launcher/): contains an immitation of the resources found in `steam.exe`
+