Mercurial > nsnake
view INSTALL.md @ 26:137ead4860a0
Misc: style
author | David Demelier <markand@malikania.fr> |
---|---|
date | Mon, 22 Oct 2018 20:16:00 +0200 |
parents | 0e0ee35dae66 |
children | 0c49fb9c5420 |
line wrap: on
line source
NSnake INSTALL ============== To build nsnake, you need a C compiler, [CMake][] and the curses library. Note for Windows ---------------- NSnake has been ported to Windows using pdcurses, it is bundled with nsnake and does not need to be installed separately. Build ----- Go to the source directory and type the following commands mkdir _build_ cd _build_ cmake .. -DCMAKE_BUILD_TYPE=Release make make install See the CMake documentation for other generators. Options ------- The following boolean options are available: - **WITH_DOCS**: set to false if you don't want documentation to be installed, - **WITH_MAN**: set to false if you don't want manual pages to be installed. The following directories may be adjusted: - **WITH_DOCDIR**: the directory where to install documentation files, - **WITH_MANDIR**: the root directory where to install manual files. Example: cmake .. -DWITH_DOCS=Off -DWITH_MANDIR=man Scores file ----------- NSnake uses a scores file in order to share all users scores on the same machine. In order to work, nsnake is installed with setgid bit set and **games** as user and group. The directory for saving the scores is writable by this group to make sure the executable can write it from any user. You can adjust the user, group and scores directory with the following options: - **WITH_USER**: the uid passed in `chown` command, - **WITH_GROUP**: the gid passed in `chown` command, - **WITH_DBDIR**: the directory where to store the scores file. Note: these options have no effects on Windows. Example: cmake .. -DWITH_USER=nobody -DWITH_GROUP=nobody -DWITH_DBDIR=/var/cache/nsnake [CMake]: http://cmake.org