1 README.portable
2 ===============
3 
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.
6 
7 Currently this has only been tested on Linux and FreeBSD, although the BSDs
8 are already packaging Got via ports so this isn't a core focus of this
9 portable repository, but patches to improve portability across systems are
10 welcomed.
11 
12 DEPENDENCIES
13 ============
14 
15 Got requires the following dependencies:
16 
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)
22 * `pkg-config` (for searching libraries)
23 
24 TESTS (REGRESS)
25 ===============
26 
27 There are tests under regress/ -- these are designed to work on OpenBSD.  For
28 now, the cmdline/ tests have been prioritised.
29 
30 To run the test suite:
31 
32 ```
33  $ make tests
34 ```
35 
36 NOTE:  THIS ONLY WORKS AFTER `make install` DUE TO HOW PATHS TO LIBEXEC
37        HELPERS ARE HARD-CODED INTO THE BINARIES.
38 
39 INSTALLATION
40 ============
41 
42 ```
43  $ ./autogen.sh
44  $ ./configure && make
45  $ sudo make install
46 ```
47 
48 BRANCHES + SUBMITTING PATCHES
49 =============================
50 
51 `got-portable` has two key branches:
52 
53 * `main` which tracks got upstream untainted.
54 * `linux` which provides the portable version of GoT based from code on `main`
55 
56 Patches for portable code fixes should be based from the `linux` branch and
57 sent to the mailing list for review [2] or sent to me directly (see CONTACT).
58 
59 The read-only Github repository also runs CI checks using Cirrus-CI on Linux
60 and FreeBSD.
61 
62 TODO
63 ====
64 
65 This port is incomplete in that only got(1) and tog(1) have been ported.
66 gotweb has yet to be ported.
67 
68 configure.ac should start defining AC_ENABLE arguments to allow for
69 finer-grained control of where to search for includes/libraries, etc.
70 
71 CONTACT
72 =======
73 
74 Thomas Adam <thomas@xteddy.org>
75 thomas_adam (#gameoftrees on irc.libera.chat)
76 
77 [1]  https://gameoftrees.org
78 [2]  https://lists.openbsd.org/cgi-bin/mj_wwwusr?user=&passw=&func=lists-long-full&extra=gameoftrees