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