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  $ mkdir ~/bin
16  $ make install
17 
18 This will install the following commands to ~/bin:
19 
20  got (command line interface)
21  tog (ncurses interface)
22  and several helper programs from the libexec directory
23 
24 Tests will pass only after 'make install' because they rely on installed
25 binaries in $PATH. Tests in the cmdline directory currently depend on git(1).
26 
27  $ doas pkg_add git
28  $ make regress
29 
30 Man pages are not installed yet but can be viewed with mandoc:
31 
32  $ mandoc got/got.1 | less
33  $ mandoc got/git-repository.5 | less
34  $ mandoc got/got-worktree.5 | less
35  $ mandoc tog/tog.1 | less
36 
37 
38 Guidelines for reporting problems:
39 
40 All problem/bug reports should include a reproduction recipe in form of a
41 shell script which starts out with an empty repository and runs a series of
42 Got and/or Git commands to trigger the problem, be it a crash or some other
43 undesirable behaviour.
44 
45 The regress/cmdline directory contains plenty of example scripts.
46 An ideal reproduction recipe is written as an xfail ("expected failure")
47 regression test. For a real-world example of an xfail test, see commits
48 4866d0842a2b34812818685aaa31d3e0a966412d and
49 2b496619daecc1f25b1bc0c53e01685030dc2c74 in Got's history.
50 
51 Please take this request very seriously; Ask for help with writing your
52 regression test before asking for your problem to be fixed. Time invested
53 in writing a regression test saves time wasted on back-and-forth discussion
54 about how the problem can be reproduced. A regression test will need to be
55 written in any case to verify a fix and prevent the problem from resurfacing.
56 
57 It is also possible to write test cases in C. Various examples of this
58 exist in the regress/ directory. Most such tests are unit tests written
59 before Got's command line interface was available; it is unlikely that a
60 problem found during regular usage will require a test to be written in C.
61 
62 Some areas of code, such as the tog UI, are not covered by automated tests.
63 Please always try to find a way to trigger your problem via the command line
64 interface before reporting a problem without a written test case included.
65 If writing an automated test really turns out to be impossible, please
66 explain in very clear terms how the problem can be reproduced.
67 
68 Mail problem reports to: Stefan Sperling <stsp@stsp.name>
69 
70 
71 Guidelines for submitting patches:
72 
73 Please keep the intended target audience in mind when contributing to Got.
74 Patches related to non-OpenBSD systems will not be integrated before an
75 official portable version of Got is being worked on, if ever.
76 
77 Please refrain from sending long series of patches without prior discussion.
78 
79 Mail patches to: Stefan Sperling <stsp@stsp.name>
80 
81 Pull requests via any Git hosting sites will likely be overlooked or ignored.