commit 7cc94e29d3adf2b69dedf6c238eb04cfb255089c
from: Stefan Sperling <stsp@stsp.name>
date: Sat Sep 08 15:08:45 2018 UTC

add a README file

commit - 079b2f6564ee7fbd71071aedde0c3c317b985d46
commit + 7cc94e29d3adf2b69dedf6c238eb04cfb255089c
blob - /dev/null
blob + 94812f8f2a0bac465e3b642b6661d9a35a327822 (mode 644)
--- /dev/null
+++ README
@@ -0,0 +1,27 @@
+Got is a version control system which prioritizes ease of use and
+simplicity over flexibility. It is being developed exlusively on
+OpenBSD and most likely won't compile on other operating systems.
+
+To compile the Got tool suite on OpenBSD, run:
+
+ $ make obj
+ $ make
+ $ mkdir ~/bin
+ $ make install
+
+This will install the following commands to ~/bin:
+
+ got (command line interface)
+ tog (ncurses interface)
+ and several helper programs from the libexec directory
+
+The tests will pass only after 'make install' because
+they rely on installed libexec binaries:
+
+ $ make regress
+
+Man pages are not installed yet but can be viewed with mandoc:
+
+ $ mandoc got/got.1 | less
+ $ mandoc got/git-repository.5 | less
+ $ mandoc tog/tog.1 | less