From efd2b31b4a8ea3b78f69ebbdb171e10917fba89a Mon Sep 17 00:00:00 2001
From: Maarten van Heusden <50550545+mmvanheusden@users.noreply.github.com>
Date: Mon, 22 Jan 2024 19:11:59 +0100
Subject: [PATCH] feat: add readme
---
README.md | 114 +++++-------------------------------------------------
1 file changed, 10 insertions(+), 104 deletions(-)
diff --git a/README.md b/README.md
index d6879464..f366a101 100644
--- a/README.md
+++ b/README.md
@@ -1,107 +1,13 @@
+# SteamDepotDownloaderGUI for steam-deck
-SteamDepotDownloaderGUI
+**This branch houses the Steam Deck-compatible version of SteamDepotDownloaderGUI**
+Code is pretty messy, but it (should) work.
-A graphical wrapper for DepotDownloader, designed to make downloading older versions of Steam games easy. built using Electron.
-
-→Tutorial ~
-Subnautica←
-
+
-
-
-
-
-
-
- 
-
-
-## Features
-
-* **Cross platform**
- - Windows
- - macOS (in development™)
- - Linux
-* **Cross terminal**
- - Gnome Terminal
- - Konsole
- - xfce4-terminal
- - Terminator
- - Terminology
- - xterm
- - Kitty
- - LXTerminal
- - Tilix
- - Deepin Terminal
- - cool-retro-term
- - Manual: produce a script that can be copy pasted into a terminal of choice
-* **Support for anonymous downloads**
-
-## Download
-
-### Windows:
-* If you haven't already, install [.NET SDK 6.0](https://dotnet.microsoft.com/en-us/download/dotnet/6.0) on your computer.
- Then, download the [latest Windows build](https://github.com/mmvanheusden/SteamDepotDownloaderGUI/releases/latest)
-### **Linux:**
-#### Arch Linux:
-* An official [AUR package](https://aur.archlinux.org/packages/steamdepotdownloadergui-appimage) has been made. this can be installed using `yay -S steamdepotdownloadergui-appimage`.
-#### Other Linux distros:
-* **You'll need `unzip`, .NET SDK 6.0.**
-* **Ubuntu:**
-
- `sudo apt install unzip dotnet-sdk-6.0`
-* **Fedora:**
-
- `sudo dnf install unzip dotnet-sdk-6.0`
-
-
-* There are several options, AppImage, and a `.zip`, for both x64 and arm64.
-
- [Download latest release](https://github.com/mmvanheusden/SteamDepotDownloaderGUI/releases/latest)
-
-
-## How to use
-
-#### Tutorials:
-* https://www.youtube.com/watch?v=H2COwT5OUOo How to download older versions of Steam games. rollback steam games tutorial
-* https://www.youtube.com/watch?v=ogiDAuH3VdY How to download older versions of Subnautica tutorial
----
-
-**Enter everything you normally would in the DepotDownloader console and select your OS/terminal and click download**
-
-
-## Credits
-
-This software makes use of the following projects:
-- [**DepotDownloader**](https://github.com/SteamRE/DepotDownloader/)
-- [Electron](https://www.electronjs.org/)
-- [Node.js](https://nodejs.org/)
-- [Primer CSS](https://primer.style/css/)
-- [follow-redirects](https://github.com/follow-redirects/follow-redirects)
-- [Hubut Sans](https://github.com/github/hubot-sans) under [license](https://github.com/github/hubot-sans/blob/05d5ea150c20e6434485db8ffd2277ed18a9e911/LICENSE)
-
-
-## Donate
-
-Donations can be made through Liberapay :)
-
-
- 
-
-
-## On Electron
-Computer resources are not an all-you-can-eat buffet. The executables weigh on average 103 MB.
-That's why in the future, this project is fully switching to a [different](https://tauri.app/) (multi-platform) toolset. Nothing will change for the user.
-
-## Contribute
-
-If you would like to contribute to SteamDepotDownloaderGUI, please make sure to follow
-the [contributing instructions and guidelines](contributing.md).
-
-Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
-
-Please make sure to keep code clean and cross-platform compatible.
-
-
+1. To use, download the build from [**Here**]()
+and run it.
+2. Now open the file and click on the gear icon.
+3. Click "Auto Download .NET" and wait for it to finish.
+4. Should be good to go!
+**If any issues arise, please join the [support Discord](discord.com/invite/3qCt4DT5qe) and ask there. **