diff --git a/README.md b/README.md index e69de29..64b4bcd 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,29 @@ +# Steam .desktop fixer + +This is a tool for recreating .desktop files for steam apps automatically. + +## Windows/MacOS Warning + +This app is ONLY for Linux, not Windows or MacOS. (how would you even have this issue on either anyway?) + +## Why do I need this? + +This is useful, for if you somehow don't have .desktop files to launch your games/software/tools on steam. For example, this could happen when you added a storage device as a steam library, but since you didn't install it on that OS, it didn't create the .desktop files, this is why I made this in the first place. + +## Installation + +1. Clone the repository + +2. Have uv installed + + If you don't have it, follow the instructions at [Installation | uv](https://docs.astral.sh/uv/getting-started/installation/) for an installation guide + +3. Navigate to the repository folder + +4. Run the following command: + +5. ```bash + uv run main.py + ``` + +6. Follow the instructions in the program