Portable version of Game of Trees https://gameoftrees.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

2.0 KiB

README.portable
===============

This is the portable version of got[1] (Game of Trees), using autotools to
provide the library checks required for Got's dependencies.

Currently this has only been tested on Linux and FreeBSD, although the BSDs
are already packaging Got via ports so this isn't a core focus of this
portable repository, but patches to improve portability across systems are
welcomed.

DEPENDENCIES
============

Got requires the following dependencies:

* `libncurses` (for tog(1))
* `libmd` (BSD's digest routines)
* `libcrypto` (often via 'libssl-dev' for SHA1 routines)
* `libuuid` (for UUID generation)
* `libz` (for Z compression)
* `pkg-config` (for searching libraries)

TESTS (REGRESS)
===============

There are tests under regress/ -- these are designed to work on OpenBSD. For
now, the cmdline/ tests have been prioritised.

To run the test suite:

```
$ make tests
```

NOTE: THIS ONLY WORKS AFTER `make install` DUE TO HOW PATHS TO LIBEXEC
HELPERS ARE HARD-CODED INTO THE BINARIES.

INSTALLATION
============

```
$ ./autogen.sh
$ ./configure && make
$ sudo make install
```

BRANCHES + SUBMITTING PATCHES
=============================

`got-portable` has two key branches:

* `main` which tracks got upstream untainted.
* `linux` which provides the portable version of GoT based from code on `main`

Patches for portable code fixes should be based from the `linux` branch and
sent to the mailing list for review [2] or sent to me directly (see CONTACT).

The read-only Github repository also runs CI checks using Cirrus-CI on Linux
and FreeBSD.

TODO
====

This port is incomplete in that only got(1) and tog(1) have been ported.
gotweb has yet to be ported.

configure.ac should start defining AC_ENABLE arguments to allow for
finer-grained control of where to search for includes/libraries, etc.

CONTACT
=======

Thomas Adam <thomas@xteddy.org>
thomas_adam (#gameoftrees on irc.libera.chat)

[1] https://gameoftrees.org
[2] https://lists.openbsd.org/cgi-bin/mj_wwwusr?user=&passw=&func=lists-long-full&extra=gameoftrees