diff --git a/README.md b/README.md index bed7169..51fc1e9 100644 --- a/README.md +++ b/README.md @@ -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