Commit 270ebbdc1383b269d75f45d12e8dacc072df8538
2020-01-16T14:34:36
merge gotweb's README into top-level README; ok kn tracey
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
diff --git a/README b/README
index 94876ae..8f340f4 100644
--- a/README
+++ b/README
@@ -46,6 +46,42 @@ Man page files in the Got source tree can be viewed with 'man -l':
EXAMPLES in got.1 contains a quick-start guide for OpenBSD developers.
+Game of Trees Web (Gotweb) is a CGI program which displays repository data
+and is designed to work with httpd(8).
+
+To compile gotweb on OpenBSD, run:
+
+ # pkg_add kcgi
+ $ make web
+ # make web-install
+
+This will create the following files:
+ the CGI program /var/www/cgi-bin/gotweb/gotweb
+ helper programs from the libexec directory in /var/www/cgi-bin/gotweb/libexec
+ several template files in /var/www/cgi-bin/gw_tmpl/
+ html, css, and image files in /var/www/htdocs/gotweb/gotweb/
+ the directory /var/www/tmp/
+ man pages (only installed if building sources from a Got release tarball)
+
+Example configuration for httpd.conf:
+
+ types { include "/usr/share/misc/mime.types" }
+ server "localhost" {
+ listen on * port 80
+ root "/htdocs/gotweb"
+ location "/cgi-bin/*" {
+ root "/"
+ fastcgi
+ }
+ location "/*" {
+ directory index "index.html"
+ }
+ }
+
+Gotweb's run-time behaviour can be configured in the gotweb.conf file:
+
+ $ man -l gotweb/gotweb.conf.5
+
Guidelines for reporting problems:
diff --git a/gotweb/README b/gotweb/README
deleted file mode 100644
index b91a767..0000000
--- a/gotweb/README
+++ /dev/null
@@ -1,53 +0,0 @@
-Game of Trees Web (Gotweb) is a read-only web front-end for 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
-
-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.