1 Game of Trees (Got) is a version control system which prioritizes ease
2 of use and simplicity over flexibility (https://gameoftrees.org)
4 Got is still under development; it is being developed exclusively
5 on OpenBSD and its target audience are OpenBSD developers. Got is
6 ISC-licensed and was designed with pledge(2) and unveil(2) in mind.
8 Got uses Git repositories to store versioned data. At present, Got
9 supports local version control operations only. Git can be used
10 for any functionality which has not yet been implemented in Got.
11 It will always remain possible to work with both Got and Git on
14 To compile the Got tool suite on OpenBSD, run:
20 This will install the following commands:
22 got, the command line interface
23 tog, an ncurses-based interactive Git repository browser
24 several helper programs from the libexec directory
25 man pages (only installed if building sources from a Got release tarball)
27 A Got release tarball will install files under /usr/local by default.
28 A build started in Got's Git repository will install files under ~/bin.
30 Tests will pass only after 'make install' because they rely on installed
31 binaries in $PATH. Tests in the cmdline directory currently depend on git(1).
32 Tests in 'clone.sh' and 'fetch.sh' will fail if 'ssh 127.0.0.1' does not
33 succeed non-interactively.
38 To test with packed repositories, run:
40 $ make regress GOT_TEST_PACK=1
42 Because got unveils the /tmp directory by default using the /tmp directory
43 for test data can hide bugs. However, /tmp remains the default because
44 there is no better alternative that works out of the box. In order to
45 store test data in a directory other than /tmp, such as ~/got-test, run:
48 $ make regress GOT_TEST_ROOT=~/got-test
50 Man page files in the Got source tree can be viewed with 'man -l':
53 $ man -l got/git-repository.5
54 $ man -l got/got-worktree.5
57 EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers.
60 Game of Trees Web (Gotweb) is a CGI program which displays repository data
61 and is designed to work with httpd(8) and slowcgi(8). It requires the Kristaps
62 Dzonsons kcgi library, version 0.12.0 or greater.
64 To compile gotweb on OpenBSD, run:
70 This will create the following files:
71 the CGI program /var/www/cgi-bin/gotweb/gotweb
72 helper programs from the libexec directory in /var/www/cgi-bin/gotweb/libexec
73 several template files in /var/www/cgi-bin/gw_tmpl/
74 html, css, and image files in /var/www/htdocs/gotweb/
75 the directory /var/www/got/tmp/
76 man pages (only installed if building sources from a Got release tarball)
78 Documentation is available in manual pages:
80 $ man -l gotweb/gotweb.8
81 $ man -l gotweb/gotweb.conf.5
84 Guidelines for reporting problems:
86 All problem/bug reports should include a reproduction recipe in form of a
87 shell script which starts out with an empty repository and runs a series of
88 Got and/or Git commands to trigger the problem, be it a crash or some other
89 undesirable behaviour.
91 The regress/cmdline directory contains plenty of example scripts.
92 An ideal reproduction recipe is written as an xfail ("expected failure")
93 regression test. For a real-world example of an xfail test, see commits
94 4866d0842a2b34812818685aaa31d3e0a966412d and
95 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
97 Please take this request very seriously; Ask for help with writing your
98 regression test before asking for your problem to be fixed. Time invested
99 in writing a regression test saves time wasted on back-and-forth discussion
100 about how the problem can be reproduced. A regression test will need to be
101 written in any case to verify a fix and prevent the problem from resurfacing.
103 It is also possible to write test cases in C. Various examples of this
104 exist in the regress/ directory. Most such tests are unit tests; it is
105 unlikely that a problem found during regular usage will require a test
108 Some areas of code, such as the tog UI, are not covered by automated tests.
109 Please always try to find a way to trigger your problem via the command line
110 interface before reporting a problem without a written test case included.
111 If writing an automated test really turns out to be impossible, please
112 explain in very clear terms how the problem can be reproduced.
114 Mail problem reports to: gameoftrees@openbsd.org
117 Guidelines for submitting patches:
119 Mail patches to: gameoftrees@openbsd.org
120 Pull requests via any Git hosting sites will likely be overlooked.
121 Please keep the intended target audience in mind when contributing to Got.
124 Subscribing to the gameoftrees@openbsd.org mailing list:
126 The mailing list is used for patch reviews, bug reports, and user questions.
127 To subscribe, send mail to majordomo@openbsd.org with a message body of:
128 subscribe gameoftrees
130 See https://www.openbsd.org/mail.html for more information.
