commit - 87db323e65c704c9186f9876bcec01012a891dd2
commit + 14b963258a82b08d55ba828b109207bca28b1329
blob - 46af06afd32c72f4d45ab5cb8e6d8124afee0876
blob + c63ca834be73da69a2851808511a8bada49b3d10
--- gotweb/README
+++ gotweb/README
-***THIS IS NOT FINISHED CODE***
-gotweb README
+Game of Trees Web (Gotweb) is a read-only web implementation of Got.
+
+Gotweb is still under development; it is being developed exclusively
+on OpenBSD and its target audience are OpenBSD developers. Gotweb is
+ISC-licensed and was designed with pledge(2) and unveil(2) in mind.
+
+Gotweb uses bare Git repositories to read versioned data and is designed to
+work with httpd(8).
+
+To compile the Gotweb tool suite on OpenBSD, run:
+
+ $ make web
+ # make web-install
+
+This will install Gotweb and all the required files to /var/www by default.
+
+Man page files in the Gotweb source tree can be viewed with 'man -l':
+
+ $ man -l gotweb/gotweb.conf.5
+
+Guidelines for reporting problems:
+
+Report all Gotweb problems in as much detail as possible. Gotweb code is not
+covered by automated tests.
+
+Mail problem reports to: gameoftrees@openbsd.org
+
+Example configuration for httpd.conf:
+
+ext_if = "*"
+
+types { include "/usr/share/misc/mime.types" }
+
+server "localhost" {
+ listen on $ext_if port 80
+
+ root "/htdocs/gotweb"
+
+ location "/cgi-bin/*" {
+ root "/"
+ fastcgi
+ }
+ location "/*" {
+ directory index "index.html"
+ }
+}
+
+Guidelines for submitting patches:
+
+Mail patches to: gameoftrees@openbsd.org
+Pull requests via any Git hosting sites will likely be overlooked.
+Please keep the intended target audience in mind when contributing to Gotweb.
+
+
+Subscribing to the gameoftrees@openbsd.org mailing list:
+
+The mailing list is used for patch reviews, bug reports, and user questions.
+To subscribe, send mail to majordomo@openbsd.org with a message body of:
+subscribe gameoftrees
+
+See https://www.openbsd.org/mail.html for more information.
