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

Update installation instructions

Browse source 
closes #1
This commit is contained in:
Sam Tay 2017-06-21 01:25:47 -04:00 • committed by GitHub
parent 4852ef756e
commit 1e831bf6a6
1 changed files with 25 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -6,7 +6,11 @@ A terminal interface for Tetris
## installation
For Mac and Linux, the binaries attached to the GitHub release should suffice.
For Mac and Linux, the binaries attached to the GitHub release should suffice ([instructions](#github-release-binaries)). For other Linux distros, you can try the Linux binary as well but no guarantees. See the other two options, installing from [source](#install-from-source) and [dex](#install-via-dex).
I have not tested Windows, but I do think it should work via dex. Please let me know in an issue if it fails so I can update documentation. Thanks!
#### github release binaries
Here is a quick way to get the one for your OS:
```bash
curl -L https://github.com/samtay/tetris/releases/download/0.1.0/tetris-`uname -s`-`uname -m` -o tetris
@ -14,21 +18,38 @@ chmod +x tetris
sudo mv tetris /usr/local/bin/
```
For Windows, you have to install from source. First [get stack](https://docs.haskellstack.org/en/stable/README/#how-to-install). Then
#### install from source
First [get stack](https://docs.haskellstack.org/en/stable/README/#how-to-install). Then
```bash
git clone https://github.com/samtay/tetris.git
cd 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
# install globally (so that you dont need to run `dex run tetris`)
dex install --global tetris
# test it out
tetris
```
## screenshots
#### Linux termite - tomorrow night eighties
![linux-tomorrow-night-80s](./docs/img/linux_tomorrow_night_80s.png)
#### Mac terminal - plain
![mac-terminal-plain](./docs/img/mac_plain.png)
#### Mac terminal - grass
![mac-terminal-grass](./docs/img/mac_grass.png)
## todo