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