1 dd038bc6 2021-09-21 thomas.ad README.portable
2 dd038bc6 2021-09-21 thomas.ad ===============
4 dd038bc6 2021-09-21 thomas.ad This is the portable version of got[1] (Game of Trees), using autotools to
5 e499844e 2022-03-03 thomas provide the library checks required for GoT's dependencies.
7 e499844e 2022-03-03 thomas The following operating systems are supported:
11 b26177ad 2022-03-03 thomas * DragonFlyBSD
15 dd038bc6 2021-09-21 thomas.ad DEPENDENCIES
16 dd038bc6 2021-09-21 thomas.ad ============
20 00ced238 2021-09-24 thomas * `libncurses` (for tog(1))
21 00ced238 2021-09-24 thomas * `libmd` (BSD's digest routines)
22 bd1cad3c 2022-04-30 thomas * `libbsd` (BSD's arc4random routines)
23 00ced238 2021-09-24 thomas * `libcrypto` (often via 'libssl-dev' for SHA1 routines)
24 00ced238 2021-09-24 thomas * `libuuid` (for UUID generation)
25 00ced238 2021-09-24 thomas * `libz` (for Z compression)
26 00ced238 2021-09-24 thomas * `pkg-config` (for searching libraries)
27 ebc794c1 2021-10-20 thomas * `bison` (for configuration file grammar)
28 293e816c 2022-07-14 thomas * `libevent` (for gotwebd)
29 f349577f 2022-07-15 thomas * `libtls` (for gotwebd)
33 e499844e 2022-03-03 thomas * `automake`
34 e499844e 2022-03-03 thomas * `pkgconf`
35 e8da6c41 2022-07-10 thomas * `GNU coreutils` (for running tests)
36 293e816c 2022-07-14 thomas * `libevent` (for gotwebd)
37 f349577f 2022-07-15 thomas * `libtls` (for gotwebd)
41 e499844e 2022-03-03 thomas * `automake`
42 e499844e 2022-03-03 thomas * `libuuid`
43 e499844e 2022-03-03 thomas * `ncuresesw`
44 e8da6c41 2022-07-10 thomas * `GNU coreutils` (for running tests)
45 293e816c 2022-07-14 thomas * `libevent` (for gotwebd)
47 b26177ad 2022-03-03 thomas DragonFlyBSD:
49 b26177ad 2022-03-03 thomas * `automake`
50 b26177ad 2022-03-03 thomas * `pkgconf`
51 b26177ad 2022-03-03 thomas * `openssl`
52 e8da6c41 2022-07-10 thomas * `GNU coreutils` (for running tests)
53 293e816c 2022-07-14 thomas * `libevent` (for gotwebd)
55 e499844e 2022-03-03 thomas Darwin (MacOS):
57 e499844e 2022-03-03 thomas * `automake`
59 e499844e 2022-03-03 thomas * `pkg-config`
60 e499844e 2022-03-03 thomas * `ncurses`
61 e499844e 2022-03-03 thomas * `openssl`
62 e499844e 2022-03-03 thomas * `ossp-uuid`
63 e8da6c41 2022-07-10 thomas * `GNU coreutils` (for running tests)
64 293e816c 2022-07-14 thomas * `libevent` (for gotwebd)
65 f349577f 2022-07-15 thomas * `libtls` (for gotwebd)
67 d3f2ad5e 2021-09-21 thomas.ad TESTS (REGRESS)
68 d3f2ad5e 2021-09-21 thomas.ad ===============
70 d3f2ad5e 2021-09-21 thomas.ad To run the test suite:
73 d3f2ad5e 2021-09-21 thomas.ad $ make tests
76 1317cd3a 2022-03-08 thomas NOTE: For Linux, you must have the jot(1) command which is typically in the
77 e8da6c41 2022-07-10 thomas `athena-jot` package, or similar. For non-linux systems (as mentioned above),
78 e8da6c41 2022-07-10 thomas GNU coreutils needs to be installed.
80 00ced238 2021-09-24 thomas NOTE: THIS ONLY WORKS AFTER `make install` DUE TO HOW PATHS TO LIBEXEC
81 d3f2ad5e 2021-09-21 thomas.ad HELPERS ARE HARD-CODED INTO THE BINARIES.
83 dd038bc6 2021-09-21 thomas.ad INSTALLATION
84 dd038bc6 2021-09-21 thomas.ad ============
87 72931428 2021-09-21 thomas.ad $ ./autogen.sh
88 dd038bc6 2021-09-21 thomas.ad $ ./configure && make
89 dd038bc6 2021-09-21 thomas.ad $ sudo make install
92 00ced238 2021-09-24 thomas BRANCHES + SUBMITTING PATCHES
93 00ced238 2021-09-24 thomas =============================
95 00ced238 2021-09-24 thomas `got-portable` has two key branches:
97 00ced238 2021-09-24 thomas * `main` which tracks got upstream untainted.
98 2f4dd2c2 2021-09-27 thomas * `linux` which provides the portable version of GoT based from code on `main`
100 00ced238 2021-09-24 thomas Patches for portable code fixes should be based from the `linux` branch and
101 00ced238 2021-09-24 thomas sent to the mailing list for review [2] or sent to me directly (see CONTACT).
103 00ced238 2021-09-24 thomas The read-only Github repository also runs CI checks using Cirrus-CI on Linux
104 00ced238 2021-09-24 thomas and FreeBSD.
109 dd038bc6 2021-09-21 thomas.ad configure.ac should start defining AC_ENABLE arguments to allow for
110 dd038bc6 2021-09-21 thomas.ad finer-grained control of where to search for includes/libraries, etc.
112 dd038bc6 2021-09-21 thomas.ad CONTACT
113 dd038bc6 2021-09-21 thomas.ad =======
115 dd038bc6 2021-09-21 thomas.ad Thomas Adam <thomas@xteddy.org>
116 72931428 2021-09-21 thomas.ad thomas_adam (#gameoftrees on irc.libera.chat)
118 dd038bc6 2021-09-21 thomas.ad [1] https://gameoftrees.org
119 6bfde126 2021-09-29 thomas [2] https://lists.openbsd.org/cgi-bin/mj_wwwusr?user=&passw=&func=lists-long-full&extra=gameoftrees
