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