Skip to content

Commit

Permalink
Rewrite the README
Browse files Browse the repository at this point in the history
  • Loading branch information
mmvanheusden committed Jul 8, 2022
1 parent 33a88f1 commit 1a3e6d7
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 10 deletions.
38 changes: 28 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,33 @@
# SteamDepotDownloaderGUI Electron rewrite (experimental)
<h1 align="center">SteamDepotDownloaderGUI</h1>

<p align="center">
<img alt="Project Status" src="https://img.shields.io/badge/status-being_rewritten-blue" />
<img alt="GitHub all releases" src="https://img.shields.io/github/downloads/mmvanheusden/SteamDepotDownloaderGUI/total?color=orange&label=downloads">
<img alt="GitHub last commit" src="https://img.shields.io/github/last-commit/mmvanheusden/SteamDepotDownloaderGUI?color=crimson">
<img alt="Visitor Count" src="https://visitor-badge.glitch.me/badge?page_id=mmvanheusden.SteamDepotDownloaderGUI">
</p>
<p align="center">
<img alt="Screenshot" src="screenshot.png" />
</p>

## How to setup dev environment
* First, install `npm`, `nodejs` and Electron on your system.
<p align="center">SteamDepotDownloaderGUI is a graphical user interface for DepotDownloader.</p>
<p align="center">You can download older versions of Steam games, useful for testing and speedrunners.</p>

> For Arch Linux users, run `sudo pacman -S npm nodejs electron`
## Installation

* Then, git clone this repo, change direcory into the repo and run `git checkout rewrite`.
* Now run `npm install`
* You now can start the GUI with `npm start`
Download the latest release for your operating system
from [GitHub](https://github.com/mmvanheusden/SteamDepotDownloaderGUI/releases/latest).

## Building
* cd into the repo
* `npm run build`
## Usage

Enter everything you normally would in the SteamDepotDownloader console.

There is a video tutorial available [here](https://www.youtube.com/watch?v=dQw4w9WgXcQ).

## Contributing

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 consistent and cross-platform compatible.

![License](license.png)
Binary file added license.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1a3e6d7

Please sign in to comment.