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