tty-solitaire/README.md
2015-05-10 19:32:34 -03:00

50 lines
1.2 KiB
Markdown

# tty-solitaire
ncurses-based klondike solitaire game.
![ttysolitaire gameplay](https://raw.github.com/mpereira/tty-solitaire/master/resources/ttysolitaire.gif)
## Dependencies
- Terminal emulator with UTF-8 support
- C library with multibyte locales support
- Ncurses with wide-char/UTF-8 support
### Installing Ncurses
#### Ubuntu
$ sudo apt-get install libncurses5-dev libncursesw5-dev
#### OS X
OS X has ncurses with wide character support out of the box. If you want to use
other ncurses libraries (from Macports, Homebrew, etc.) you will still be able
to do so if you specify LDLAGS in the make invocation. See
[this pull request](https://github.com/mpereira/tty-solitaire/pull/8) for more
information.
## Compile
$ git clone https://github.com/mpereira/tty-solitaire.git
$ cd tty-solitaire
$ make
## Install
$ sudo make install
## Play
$ ttysolitaire
## Usage
usage: ttysolitaire [-v|--version] [-h|--help] [-p|--passes=NUMBER]
-v, --version Show version
-h, --help Show this message
-p, --passes Number of passes through the deck
## Running the unit tests
$ make test
## Author
[Murilo Pereira](http://murilopereira.com)
## License
[MIT](http://opensource.org/licenses/MIT)