1 Game of Trees (Got) is a version control system which prioritizes ease
2 of use and simplicity over flexibility.
3 
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.
7 
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
12 the same repository.
13 
14 To compile the Got tool suite on OpenBSD, run:
15 
16  $ make obj
17  $ make
18  $ make install
19 
20 This will install the following commands:
21 
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)
26 
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.
29 
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 
33  $ doas pkg_add git
34  $ make regress
35 
36 To test with packed repositories, run:
37 
38  $ make regress GOT_TEST_PACK=1
39 
40 Man page files in the Got source tree can be viewed with 'man -l':
41 
42  $ man -l got/got.1
43  $ man -l got/git-repository.5
44  $ man -l got/got-worktree.5
45  $ man -l tog/tog.1
46 
47 EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers.
48 
49 
50 Guidelines for reporting problems:
51 
52 All problem/bug reports should include a reproduction recipe in form of a
53 shell script which starts out with an empty repository and runs a series of
54 Got and/or Git commands to trigger the problem, be it a crash or some other
55 undesirable behaviour.
56 
57 The regress/cmdline directory contains plenty of example scripts.
58 An ideal reproduction recipe is written as an xfail ("expected failure")
59 regression test. For a real-world example of an xfail test, see commits
60 4866d0842a2b34812818685aaa31d3e0a966412d and
61 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
62 
63 Please take this request very seriously; Ask for help with writing your
64 regression test before asking for your problem to be fixed. Time invested
65 in writing a regression test saves time wasted on back-and-forth discussion
66 about how the problem can be reproduced. A regression test will need to be
67 written in any case to verify a fix and prevent the problem from resurfacing.
68 
69 It is also possible to write test cases in C. Various examples of this
70 exist in the regress/ directory. Most such tests are unit tests; it is
71 unlikely that a problem found during regular usage will require a test
72 to be written in C.
73 
74 Some areas of code, such as the tog UI, are not covered by automated tests.
75 Please always try to find a way to trigger your problem via the command line
76 interface before reporting a problem without a written test case included.
77 If writing an automated test really turns out to be impossible, please
78 explain in very clear terms how the problem can be reproduced.
79 
80 Mail problem reports to: gameoftrees@openbsd.org
81 
82 
83 Guidelines for submitting patches:
84 
85 Mail patches to: gameoftrees@openbsd.org
86 Pull requests via any Git hosting sites will likely be overlooked.
87 Please keep the intended target audience in mind when contributing to Got.
88 
89 
90 Subscribing to the gameoftrees@openbsd.org mailing list:
91 
92 The mailing list is used for patch reviews, bug reports, and user questions.
93 To subscribe, send mail to majordomo@openbsd.org with a message body of:
94 subscribe gameoftrees
95 
96 See https://www.openbsd.org/mail.html for more information.