Blob


1 README.portable
2 ===============
4 This is the portable version of got[1] (Game of Trees), using autotools to
5 provide the library checks required for Got's dependencies.
7 Currently this has only been tested on Linux, although in theory this should
8 still work on *BSD although the BSDs are already packaging Got via ports so
9 this isn't a core focus of this portable repository, but patches to improve
10 portability across systems are welcomed.
12 DEPENDENCIES
13 ============
15 Got requires the following libraries:
17 * libncurses (for tog(1))
18 * libmd (BSD's digest routines)
19 * libcrypto (often via 'libssl-dev' for SHA1 routines)
20 * libuuid (for UUID generation)
21 * libz (for Z compression)
23 Currently, these dependencies are searched for via pkg-config(1) which must
24 also be installed.
26 TESTS (REGRESS)
27 ===============
29 There are tests under regress/ -- these are designed to work on OpenBSD. For
30 now, the cmdline/ tests have been prioritised.
32 To run the test suite:
34 $ make tests
36 NOTE: THIS ONLY WORKS AFTER 'make install' DUE TO HOW PATHS TO LIBEXEC
37 HELPERS ARE HARD-CODED INTO THE BINARIES.
39 INSTALLATION
40 ============
42 $ ./autogen.sh
43 $ ./configure && make
44 $ sudo make install
46 TODO
47 ====
49 This port is incomplete in that only got(1) and tog(1) have been ported.
50 gotweb has yet to be ported.
52 configure.ac should start defining AC_ENABLE arguments to allow for
53 finer-grained control of where to search for includes/libraries, etc.
55 CONTACT
56 =======
58 Thomas Adam <thomas@xteddy.org>
59 thomas_adam (#gameoftrees on irc.libera.chat)
61 [1] https://gameoftrees.org