X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=README;fp=README;h=a6d9302720c70605a2813e99897c267e99638669;hb=de2c4ddcb1dc654ec94f9e1082f69b58e4ee901c;hp=ac0e0a37322fbbee2f2f1bac41de7bc7d23d2d87;hpb=cb29567ea13550651d9171455d22d57ca361ac01;p=plomrogue diff --git a/README b/README index ac0e0a3..a6d9302 100644 --- a/README +++ b/README @@ -25,20 +25,25 @@ start over in a new world, simply delete this file. System requirements / installation / running the game ----------------------------------------------------- -The game is expected to run on Linux systems that contain the ncurses library. -(It may also work on other Unix-like systems with ncurses, who knows. See - for OS -X compatibility.) Do the following steps: +The game is expected to run: +- on Unix systems with a vt100-like terminal environment (xterm will do) +- that contain the ncurses library +- and Python3 (version >= 3.2.3). + +To build it, this is furthermore necessary: +- gcc (version >= 4.7.2); some llvm masked as gcc was tested successfully on OSX +- libc library headers (libc6-dev?) +- ncurses library headers (libncurses5-dev?) + +To build and start, do the following steps: -$ git clone https://github.com/plomlompom/plomrogue -$ cd plomrogue $ ./redo $ ./roguelike -(If you got a redo build system installed and in your $PATH, you could also do a -simple "redo" instead of "./redo". The ./redo script calls a simple partial -shell script implementation of redo stored below build/redo_scripts/, written by -Nils Dagsson Moskopp a.k.a. erlehmann.) +If you got a version of djb's redo build system installed and in your $PATH, +you could also do a simple "redo" instead of "./redo". The ./redo script calls a +simple partial shell script implementation of redo stored below +./build/redo_scripts/, written by Nils Dagsson Moskopp a.k.a. erlehmann.) ./redo generates two executables ./roguelike-server and ./roguelike-client. ./roguelike is a pre-existing shell script that merely executes both of them,