Skip to content

Commit

Permalink
Details for usage
Browse files Browse the repository at this point in the history
  • Loading branch information
dmadisetti committed May 11, 2021
1 parent f7fc79f commit 369ce3d
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
# Steam TUI
[![Crates.io](https://img.shields.io/crates/v/steam-tui.svg)](https://crates.io/crates/steam-tui)

<p align="center">
<img width="600" alt="Example of rules_euler in action" src="screenshot.png">
</p>

## About
Just a simple TUI client for `steamcmd`. Allows for the graphical launching,
updating, and downloading of steam games through a simple terminal client.
Methodology informed by [steam-cli](https://github.com/berenm/steam-cli).

<p align="center">
<img width="600" alt="Example of rules_euler in action" src="screenshot.png">
</p>

## usage

Login with `steamcmd` first to cache your credentials (don't trust some random app with your passwords):
```bash
steamcmd
# Steam> login <user>
# Steam> quit
```
Launch the binary `steam-tui`, and rejoice :tada:. Help is in the client.

## Requirements

[`steamcmd`](https://wiki.archlinux.org/title/steam#SteamCMD) is required to
Expand Down

0 comments on commit 369ce3d

Please sign in to comment.