1 Game of Trees (Got) is a version control system which prioritizes ease
2 of use and simplicity over flexibility.
3 
4 Got is being developed exclusively on OpenBSD. It is not a drop-in
5 replacement for other version control systems and it does not attempt
6 to compete with anything else than the use of other version control
7 systems in the context of the OpenBSD project.
8 Got's target audience are OpenBSD developers, and its focus is directed
9 at the particular needs and use cases of the OpenBSD project.
10 
11 To compile the Got tool suite on OpenBSD, run:
12 
13  $ make obj
14  $ make
15  $ make install
16 
17 This will install the following commands:
18 
19  got, the command line interface
20  tog, an ncurses-based interactive Git repository browser
21  several helper programs from the libexec directory
22  man pages (only installed if building sources from a Got release tarball)
23 
24 A Got release tarball will install files under /usr/local by default.
25 A build started in Got's Git repository will install files under ~/bin.
26 
27 Tests will pass only after 'make install' because they rely on installed
28 binaries in $PATH. Tests in the cmdline directory currently depend on git(1).
29 
30  $ doas pkg_add git
31  $ make regress
32 
33 Man page files in the Got source tree can be viewed with 'man -l':
34 
35  $ man -l got/got.1
36  $ man -l got/git-repository.5
37  $ man -l got/got-worktree.5
38  $ man -l tog/tog.1
39 
40 EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers.
41 
42 
43 Guidelines for reporting problems:
44 
45 All problem/bug reports should include a reproduction recipe in form of a
46 shell script which starts out with an empty repository and runs a series of
47 Got and/or Git commands to trigger the problem, be it a crash or some other
48 undesirable behaviour.
49 
50 The regress/cmdline directory contains plenty of example scripts.
51 An ideal reproduction recipe is written as an xfail ("expected failure")
52 regression test. For a real-world example of an xfail test, see commits
53 4866d0842a2b34812818685aaa31d3e0a966412d and
54 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
55 
56 Please take this request very seriously; Ask for help with writing your
57 regression test before asking for your problem to be fixed. Time invested
58 in writing a regression test saves time wasted on back-and-forth discussion
59 about how the problem can be reproduced. A regression test will need to be
60 written in any case to verify a fix and prevent the problem from resurfacing.
61 
62 It is also possible to write test cases in C. Various examples of this
63 exist in the regress/ directory. Most such tests are unit tests; it is
64 unlikely that a problem found during regular usage will require a test
65 to be written in C.
66 
67 Some areas of code, such as the tog UI, are not covered by automated tests.
68 Please always try to find a way to trigger your problem via the command line
69 interface before reporting a problem without a written test case included.
70 If writing an automated test really turns out to be impossible, please
71 explain in very clear terms how the problem can be reproduced.
72 
73 Mail problem reports to: Stefan Sperling <stsp@stsp.name>
74 
75 
76 Guidelines for submitting patches:
77 
78 Mail patches to: Stefan Sperling <stsp@stsp.name>
79 Pull requests via any Git hosting sites will likely be overlooked.
80 Please keep the intended target audience in mind when contributing to Got.