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