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 * `GNU coreutils` (for running tests)
37 
38 NetBSD:
39 
40 * `automake`
41 * `libuuid`
42 * `ncuresesw`
43 * `GNU coreutils` (for running tests)
44 
45 DragonFlyBSD:
46 
47 * `automake`
48 * `pkgconf`
49 * `openssl`
50 * `GNU coreutils` (for running tests)
51 
52 Darwin (MacOS):
53 
54 * `automake`
55 * `bison`
56 * `pkg-config`
57 * `ncurses`
58 * `openssl`
59 * `ossp-uuid`
60 
61 TESTS (REGRESS)
62 ===============
63 
64 To run the test suite:
65 
66 ```
67  $ make tests
68 ```
69 
70 NOTE: For Linux, you must have the jot(1) command which is typically in the
71 `athena-jot` package, or similar.  For non-linux systems (as mentioned above),
72 GNU Coreutils needs to be installed.
73 
74 NOTE:  THIS ONLY WORKS AFTER `make install` DUE TO HOW PATHS TO LIBEXEC
75        HELPERS ARE HARD-CODED INTO THE BINARIES.
76 
77 INSTALLATION
78 ============
79 
80 ```
81  $ ./autogen.sh
82  $ ./configure && make
83  $ sudo make install
84 ```
85 
86 BRANCHES + SUBMITTING PATCHES
87 =============================
88 
89 `got-portable` has two key branches:
90 
91 * `main` which tracks got upstream untainted.
92 * `linux` which provides the portable version of GoT based from code on `main`
93 
94 Patches for portable code fixes should be based from the `linux` branch and
95 sent to the mailing list for review [2] or sent to me directly (see CONTACT).
96 
97 The read-only Github repository also runs CI checks using Cirrus-CI on Linux
98 and FreeBSD.
99 
100 TODO
101 ====
102 
103 This port is incomplete in that only got(1) and tog(1) have been ported.
104 gotweb has yet to be ported.
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