Update readme.md

2025-06-07 17:20:39 +01:00
parent 8221083da0
commit 9431eef1a3
1 changed files with 15 additions and 0 deletions
@@ -2,6 +2,21 @@

 Prints a table showcasing where the compatfolder, install folder and size of games installed on the system

+## Quick overview
+
+Minor note some terminals can't open the hyperlinks properly (konsole)
+
+Each box has a hyperlink which opens the folder/file, using a embedded hyperlink in order to reduce
+the size of the boxes and have consistency 
+
+1. finds installed steam, (apt/flatpak) 
+2. Loads .vdf from location
+3. Fetches additional steam libraries
+4. Checks mounted status (to exclude things not present)
+5. Reads game vdf from steam library locations for paths
+6. Prints compatdata ID with steam path and game name
+
+
 ## Installation

 Install packages with