nsnake

David Demelier 2019-09-05 Parent:b50f9c2d3c64 Child:dff275f0783d

37:69a71a9a0ebf Go to Latest

nsnake/INSTALL.md

misc: added signature for changeset 44c1c7726652

History
1 NSnake INSTALL
2 ==============
4 To build nsnake, you need a C compiler and ncurses.
6 Note for Windows
7 ----------------
9 NSnake works on Windows but it does not have a native curses library, however
10 you can use [pdcurses][] which is the implementation known to work with NSnake.
12 Build
13 -----
15 Go to the source directory and type the following commands:
17 make
18 make install
20 Build configuration
21 -------------------
23 The following options may be used to configure the build.
25 - `GID`: change the gid to chown (default: games),
26 - `UID`: change the uid to chown (default: games),
27 - `PREFIX`: root directory for installation
28 - `BINDIR`: change to the installation of executable (default: PREFIX/bin),
29 - `MANDIR`: change to the manual page location (default: PREFIX/share/man),
30 - `VARDIR`: change the score file database directory (default: PREFIX/var).
32 Also, edit config.mk file to adjust NSnake to your system otherwise fallback
33 implementations will be bundled in.
35 Scores file
36 -----------
38 NSnake uses a scores file in order to share all users scores on the same
39 machine. In order to work, the binary `nsnake` but have setgid file attribute
40 and its database directory with the appropriate permissions. This is
41 automatically done as `make install` step.
43 The directory for saving the scores is writable by this group to make sure the
44 executable can write it from any user.
46 [pdcurses]: https://pdcurses.org