Added readme

master
Keith Irwin 2021-07-05 18:45:29 -06:00
parent deda26e9b8
commit 9b75404b21
Signed by: ki9
GPG Key ID: DF773B3F4A88DA86
1 changed files with 20 additions and 0 deletions

20
README.md Normal file
View File

@ -0,0 +1,20 @@
# gdead
Opens grateful dead soundboards and plays them in your terminal.
## Installation
```sh
# Download
git clone https://gitea.ksn.gf4/ki9/gdead.git /usr/local/src/gdead
# "Build"
ln -s /usr/local/src/gdead/gdead /usr/local/bin/gdead
```
## Usage
Takes year, month, and day as arguments and plays the top-rated soundboard on [archive.org](https://archive.org/details/GratefulDead). All three args are required.
```sh
gdead 1969 08 16
```