Update README.
This commit is contained in:
parent
eca0819609
commit
cb2f3f7ff3
20
MIT-LICENSE
20
MIT-LICENSE
@ -1,20 +0,0 @@
|
|||||||
Copyright (c) 2010 Murilo Soares Pereira
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining
|
|
||||||
a copy of this software and associated documentation files (the
|
|
||||||
"Software"), to deal in the Software without restriction, including
|
|
||||||
without limitation the rights to use, copy, modify, merge, publish,
|
|
||||||
distribute, sublicense, and/or sell copies of the Software, and to
|
|
||||||
permit persons to whom the Software is furnished to do so, subject to
|
|
||||||
the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be
|
|
||||||
included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
||||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
||||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
||||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
||||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
||||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
||||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
31
README.md
31
README.md
@ -4,7 +4,28 @@
|
|||||||
## Dependencies
|
## Dependencies
|
||||||
- Terminal emulator with UTF-8 support
|
- Terminal emulator with UTF-8 support
|
||||||
- C library with multibyte locales support
|
- C library with multibyte locales support
|
||||||
- libncurses compiled with wide-char/UTF-8 code
|
- libncursesw
|
||||||
|
|
||||||
|
### Installing libncursesw
|
||||||
|
|
||||||
|
#### Ubuntu
|
||||||
|
|
||||||
|
$ sudo apt-get install libncursesw5-dev
|
||||||
|
|
||||||
|
#### OS X
|
||||||
|
|
||||||
|
$ sudo port install ncurses
|
||||||
|
|
||||||
|
## Compile
|
||||||
|
$ git clone https://github.com/mpereira/tty-solitaire.git
|
||||||
|
$ cd tty-solitaire
|
||||||
|
$ make
|
||||||
|
|
||||||
|
## Install
|
||||||
|
$ sudo make install
|
||||||
|
|
||||||
|
## Play
|
||||||
|
$ ttysolitaire
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
usage: ttysolitaire [-v|--version] [-h|--help] [-p|--passes=NUMBER]
|
usage: ttysolitaire [-v|--version] [-h|--help] [-p|--passes=NUMBER]
|
||||||
@ -12,11 +33,6 @@
|
|||||||
-h, --help Show this message
|
-h, --help Show this message
|
||||||
-p, --passes Number of passes through the deck
|
-p, --passes Number of passes through the deck
|
||||||
|
|
||||||
## Running the game
|
|
||||||
$ git clone https://github.com/mpereira/tty-solitaire.git
|
|
||||||
$ cd tty-solitaire
|
|
||||||
$ make && ./ttysolitaire
|
|
||||||
|
|
||||||
## Screenshots
|
## Screenshots
|
||||||

|

|
||||||

|

|
||||||
@ -29,5 +45,4 @@
|
|||||||
[Murilo Pereira](http://murilopereira.com)
|
[Murilo Pereira](http://murilopereira.com)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
Released under the
|
[MIT](http://opensource.org/licenses/MIT)
|
||||||
[MIT license](http://github.com/mpereira/embratel/blob/master/MIT-LICENSE).
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user