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

Add usage info to README

Browse source
This commit is contained in:
Sam Tay 2017-07-03 09:51:04 -04:00 • committed by GitHub
parent e91b03aed1
commit 1599b13b54
1 changed files with 15 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -46,15 +46,18 @@ dex install --global tetris
tetris tetris
``` ```
## screenshots ## usage
The default game is run by simply executing the `tetris` command.
#### Linux termite - tomorrow night eighties If the unicode characters look a bit
![linux-tomorrow-night-80s](./docs/img/linux_tomorrow_night_80s.png) wonky in your terminal, you can also run
#### Mac terminal - plain ```shell
![mac-terminal-plain](./docs/img/mac_plain.png) tetris --ascii-only # uses [] as preview cell
# or
## todo tetris --preview-chars 'XX' # uses custom characters as preview cell
```
1. Leaderboard saved to txt file (requires adding brick viewport for name entry) If you always play on level `6` and want to skip the prompt, you can start the game immediately via
and probably wrapping game in a ui state type ```shell
3. Consider refactoring (Game -> a) types with State or Reader abstraction tetris --level 6
```
Lastly, to see the current highest score, you can run `tetris --high-score`.
And of course, see `tetris --help` for help.