aadit/tetris-cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update installation options

Browse source 
Remove dex method, mention aliasing snapcraft method
This commit is contained in:
Sam Tay 2020-09-10 19:50:48 -07:00
parent 00b42dac46
commit 55f87143b4
1 changed files with 2 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -5,7 +5,7 @@ A terminal interface for Tetris
![terminal-gif](./docs/img/play.gif) ![terminal-gif](./docs/img/play.gif)
## installation ## installation
Installation on MacOS and Linux is outlined below. Windows support is questionable, but you can try to install from [source](#install-from-source) or via [dex](#install-via-dex). Installation on MacOS and Linux is outlined below. Windows support is questionable, but you can try to install from [source](#install-from-source).
#### MacOS #### MacOS
Installation on a Mac is simple with Homebrew: Installation on a Mac is simple with Homebrew:
@ -21,6 +21,7 @@ yay -S tetris-terminal-git # or yaourt, etc.
Thanks to **@thefenriswolf** this is available on most Linux distributions via [snapcraft](https://snapcraft.io/tetris-thefenriswolf): Thanks to **@thefenriswolf** this is available on most Linux distributions via [snapcraft](https://snapcraft.io/tetris-thefenriswolf):
```bash ```bash
sudo snap install tetris-thefenriswolf sudo snap install tetris-thefenriswolf
alias tetris=/snap/bin/tetris-thefenriswolf.tetris # add to .bashrc or .zshrc etc.
``` ```
#### install from source #### install from source
First [get stack](https://docs.haskellstack.org/en/stable/README/#how-to-install). Then First [get stack](https://docs.haskellstack.org/en/stable/README/#how-to-install). Then
@ -30,26 +31,6 @@ cd tetris
stack install tetris stack install tetris
``` ```
#### install via dex
[dex](https://github.com/dockerland/dex) is a really cool application manager that lets you run executables as docker images, so that you don't need to worry about installing them or their dependencies directly.
```bash
# get dex if you don't have it
curl -L http://get.iceburg.net/dex/latest-0.12.x/dex -o dex
chmod +x dex
sudo mv dex /usr/local/bin
# add tetris as a repo
dex repo add tetris https://github.com/samtay/tetris.git
# run tetris
dex run tetris
### optionally install tetris globally ###
export PATH="$HOME/.dex/bin:$PATH"
dex install --global tetris
tetris
```
## usage ## usage
The default game is run by simply executing the `tetris` command. The default game is run by simply executing the `tetris` command.