cleanup readme

[iankelling.org] / README

diff --git a/README b/README
index 1ba27afd1e5168d2d9847771e6ca2489d3f874e7..7bde51abffca797fc4d6cf747cbb4150b56a503a 100644 (file)
--- a/README
+++ b/README
@@ -1,23 +1,28 @@
 Content and automated setup of iankelling.org
 
 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://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
 
 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.
 
 hardcoded directory in setup.sh: gitroot=/a/bin/githtml. These
 directories are managed separately, mostly by rsyncing them.
 


@@ -30,23 +35,24 @@ files specific to my site that it expects.
 Dates in the blog directory can be generated with date +%F
 
 
 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
 
 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
 execute changes.
 
 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
 
 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
 
 
 * License
 


@@ -55,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.
 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.