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