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