maride/tty-solitaire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Basically github.com/mpereira/tty-solitaire with some of the PRs applied
298 Commits 1 Branch 0 Tags 571 KiB
C 97.6%
Makefile 2.4%
d44c1eb623
Go to file
Rudy Dellomas III d44c1eb623 Add C flag to allow tentative definitions 
A gcc-10 changes the default behaviour from -fcommon to -fno-common,
which causes linking errors in some build processes.

Fixes #40.
2020-06-01 12:33:57 +10:00
resources Add gameplay GIF. 2013-12-24 15:30:33 -02:00
src Redraw card background to prevent visual artefacts 2020-06-01 01:12:40 +10:00
tests Add todos for fixing errors in game tests 2018-02-12 20:45:27 +03:00
.gitignore Only update this pattern at root. 2013-12-24 15:30:20 -02:00
CHANGELOG Bump version to 1.1.1. 2018-11-10 06:00:46 +01:00
LICENSE Since 2010. 2018-08-17 14:36:00 +02:00
Makefile Add C flag to allow tentative definitions 2020-06-01 12:33:57 +10:00
README Forgot this. 2018-09-02 21:41:28 +02:00
TODO.md Updated TODO. 2011-06-19 19:40:24 -03:00

README 

# -*-org-*-

* tty-solitaire
  Ncurses-based klondike solitaire game.

  #+CAPTION: 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

** Install
*** From source
**** Install Ncurses
     tty-solitaire depends on Ncurses. Some platforms provide it out of the box
     and some don't, so you might need to install it yourself.
***** Ubuntu
      #+BEGIN_SRC bash
      sudo apt-get install libncurses5-dev libncursesw5-dev
      #+END_SRC
***** macOS
      macOS has Ncurses with wide character support out of the box, so *there's
      nothing you need to do*. If you want to use other Ncurses libraries (from
      Macports, Homebrew, etc.) you are able to do it by specifying =LDLAGS= in
      the make invocation. See [[https://github.com/mpereira/tty-solitaire/pull/8][this pull request]] for more information.
**** Install tty-solitaire
    #+BEGIN_SRC text
    $ wget -O tty-solitaire-v1.1.0.tar.gz https://github.com/mpereira/tty-solitaire/archive/v1.1.0.tar.gz
    $ tar xvf tty-solitaire-v1.1.0.tar.gz
    $ cd tty-solitaire-1.1.0
    $ make
    $ sudo make install
    #+END_SRC
*** Via package managers
    Check out https://github.com/mpereira/tty-solitaire/issues/29.

** Play
   Run in your favorite shell:
   #+BEGIN_SRC bash
   ttysolitaire
   #+END_SRC

** Usage
   #+BEGIN_SRC text
   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
   #+END_SRC

** Development
*** Get the code
    #+BEGIN_SRC bash
    git clone https://github.com/mpereira/tty-solitaire.git
    #+END_SRC
*** Run the unit tests
    #+BEGIN_SRC bash
    make test
    #+END_SRC

** Author
   [[http://murilopereira.com][Murilo Pereira]]

** License
   [[https://github.com/mpereira/tty-solitaire/blob/master/LICENSE][MIT]]