1 README.portable
2 ===============
3 
4 **NOTE: This repository is read-only and is used only to mirror the
5 got-portable repository for CI purposes.**
6 
7 This is the portable version of got[1] (Game of Trees), using autotools to
8 provide the library checks required for GoT's dependencies.
9 
10 The following operating systems are supported:
11 
12 * FreeBSD
13 * NetBSD
14 * DragonFlyBSD
15 * MacOS
16 * Linux
17 
18 DEPENDENCIES
19 ============
20 
21 Linux:
22 
23 * `libncurses` (for tog(1))
24 * `libmd` (BSD's digest routines)
25 * `libcrypto` (often via 'libssl-dev' for SHA1 routines)
26 * `libuuid` (for UUID generation)
27 * `libz` (for Z compression)
28 * `pkg-config` (for searching libraries)
29 * `bison` (for configuration file grammar)
30 
31 FreeBSD:
32 
33 * `automake`
34 * `pkgconf`
35 
36 NetBSD:
37 
38 * `automake`
39 * `libuuid`
40 * `ncuresesw`
41 
42 DragonFlyBSD:
43 
44 * `automake`
45 * `pkgconf`
46 * `openssl`
47 
48 Darwin (MacOS):
49 
50 * `automake`
51 * `bison`
52 * `pkg-config`
53 * `ncurses`
54 * `openssl`
55 * `ossp-uuid`
56 
57 TESTS (REGRESS)
58 ===============
59 
60 To run the test suite:
61 
62 ```
63  $ make tests
64 ```
65 
66 NOTE: For Linux, you must have the jot(1) command which is typically in the
67 `athena-jot` package, or similar.
68 
69 NOTE:  THIS ONLY WORKS AFTER `make install` DUE TO HOW PATHS TO LIBEXEC
70        HELPERS ARE HARD-CODED INTO THE BINARIES.
71 
72 INSTALLATION
73 ============
74 
75 ```
76  $ ./autogen.sh
77  $ ./configure && make
78  $ sudo make install
79 ```
80 
81 BRANCHES + SUBMITTING PATCHES
82 =============================
83 
84 `got-portable` has two key branches:
85 
86 * `main` which tracks got upstream untainted.
87 * `linux` which provides the portable version of GoT based from code on `main`
88 
89 Patches for portable code fixes should be based from the `linux` branch and
90 sent to the mailing list for review [2] or sent to me directly (see CONTACT).
91 
92 The read-only Github repository also runs CI checks using Cirrus-CI on Linux
93 and FreeBSD.
94 
95 TODO
96 ====
97 
98 This port is incomplete in that only got(1) and tog(1) have been ported.
99 gotweb has yet to be ported.
100 
101 configure.ac should start defining AC_ENABLE arguments to allow for
102 finer-grained control of where to search for includes/libraries, etc.
103 
104 CONTACT
105 =======
106 
107 Thomas Adam <thomas@xteddy.org>
108 thomas_adam (#gameoftrees on irc.libera.chat)
109 
110 [1]  https://gameoftrees.org
111 [2]  https://lists.openbsd.org/cgi-bin/mj_wwwusr?user=&passw=&func=lists-long-full&extra=gameoftrees