X-Git-Url: https://iankelling.org/git/?p=iankelling.org;a=blobdiff_plain;f=README;h=7957f6e087b552ddcdcdfe552a548c7a646e3847;hp=594e9dced31b36220b9535f5b2ef7d9960fbaea0;hb=refs%2Fheads%2Fmaster;hpb=41f0ed8cacb2bc3a6dd60425736bf66b223189c8

diff --git a/README b/README
index 594e9dc..4f82576 100644
--- a/README
+++ b/README
@@ -1,29 +1,35 @@
 Content and automated setup of iankelling.org
 
+* todo
 
-* Setup
+Retire comments, it should just say: email me.
 
-I use a submodule, so git clone --recursive.
-
-setup.sh sets up apache and gitweb
-build.rb does static site generation
+* Dependencies
 
-Dependencies for running ./setup.sh DOMAIN: A modern debian based system
-(tested on debian 8, and debian 8 testing).
+Requires a modern debian based OS, tested on debian 8 & 9.
 
-Some shell scripts need to be sourced before running setup.sh:
-https://iankelling.org/git/?p=distro-functions;a=summary
-And some programs need to be in PATH:
+Some programs need to be in PATH:
 https://iankelling.org/git/?p=basic-https-conf;a=summary
-https://sallymae.club/git/?p=acme-tiny-wrapper;a=summary
 chost from
 https://iankelling.org/git/?p=fai;a=summary
 
-This repo does not include the repos under /git.  In my own version, under /git are links to the .git dirs of the respective repos under the
+
+* Installation
+
+I use a submodule, so git clone --recursive.
+
+./setup.sh
+./build.rb
+
+
+* Usage notes
+
+This repo does not include the repos under /git.  In my setup,
+under /git are links to the .git dirs of the respective repos under the
 hardcoded directory in setup.sh: gitroot=/a/bin/githtml. These
 directories are managed separately, mostly by rsyncing them.
 
-Only the latest version of resume is kept in the resume branch which
+Only the latest version of resume is kept in the "r" branch which
 gets rebased on master.
 
 ./build.rb is not a generalized site generator, it has some content
@@ -32,12 +38,12 @@ files specific to my site that it expects.
 Dates in the blog directory can be generated with date +%F
 
 
-* Comments
+* Blog Comments
 
 New comments are stored in a sqlite database. There is a system for
 moderating, rate limiting, and handling comments based on previously
-seen ips. See _site/cgi/comment.  Ones that are not moderated for spam
-etc, are stored to disk for checkin on the next run of build.rb.
+seen ips. See _site/cgi/comment.  Comments that are not spam etc, are
+stored to disk for git commit on the next run of build.rb.
 get-comments, set-comments, and iank-mod.el are for moderating new
 comments. With one emacs command, you get a buffer of the new comments,
 with keybinds to mark them for publishing, moderatation, banning, and
@@ -58,6 +64,3 @@ GPLv2 or later unless stated otherwise. I'd use gplv3 or agpl, but it's
 simpler to use the same license as the gitweb javascript.
 
 The elisp is GPLv3 because emacs is.
-
-The opensans font is Apache2 licensed, from google fonts,
-the license is included in the LICENSE file.