X-Git-Url: https://iankelling.org/git/?p=iankelling.org;a=blobdiff_plain;f=README;h=7bde51abffca797fc4d6cf747cbb4150b56a503a;hp=4cbefb7bfca732e07dbb4000678baa84aec05763;hb=3da8c7ce9ed611cd12d48d5470db5725fa310f24;hpb=e02cd51eb9c9ac3f84a84fefd567d7217e34bc38

diff --git a/README b/README
index 4cbefb7..7bde51a 100644
--- a/README
+++ b/README
@@ -1,50 +1,58 @@
 Content and automated setup of iankelling.org
 
+* Dependencies
 
-* Setup
+Requires a modern debian based OS, tested on debian 8 & 9.
 
-setup.sh sets up apache and gitweb
-build.rb does static site generation
-
-Dependencies for running ./setup.sh DOMAIN: A modern debian based system
-(tested on debian 8, and debian 8 testing).
-
-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
+https://iankelling.org/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
 gets rebased on master.
 
-./build.rb does have any dependencies, but it's not a generalized site
-generator, it has some content files specific to my site that it expects.
+./build.rb is not a generalized site generator, it has some content
+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.  Ones that are not
-moderated for spam etc, are stored to disk for checkin 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 execute changes.
+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.  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
+execute changes.
 
-* Inspirations
+* Other sites that are in some way interesting:
 
 http://blog.zorinaq.com/release-of-hablog-and-new-design/?
 https://mjg59.dreamwidth.org/
 http://bettermotherfuckingwebsite.com
 https://eduardoboucas.com/blog/2015/05/11/rethinking-the-commenting-system-for-my-jekyll-site.html
+https://chris-lamb.co.uk/posts/concorde
 
 * License
 
@@ -53,6 +61,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.