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