X-Git-Url: https://codewiz.org/gitweb?p=wiki.git;a=blobdiff_plain;f=GeekiGeeki;h=17c237a4385c586d04853be351389572223feaa3;hp=c0a70861004b9f8be0b43dff5f7acb350755bfd0;hb=436ee6e77e3c4e5d79f3a704fb33949289b7d4f0;hpb=47ae08c2e981b8381477726379354b588b598548

diff --git a/GeekiGeeki b/GeekiGeeki
index c0a7086..17c237a 100644
--- a/GeekiGeeki
+++ b/GeekiGeeki
@@ -1,20 +1,87 @@
 <div style="float: right">GerryStich.jpg</div>
 
-GeekiGeeki is a fork of PikiWiki.  Its most important feature is of course the GuruMeditation alerts, but it also uses [[http://git.or.cz/ | git]] as a versioning backend.
+==== What is Geeki Geeki? ====
+
+GeekiGeeki is a minimalistic wiki with a  [[http://git.or.cz/ | git]] backend,
+a high features/complexity ratio and a clean syntax similar to WikiCreole.
 
 Check the EditingTips to get an idea the supported wiki syntax.
 
-==== Source Code ====
+GeekiGeeki is yet another fork of PikiWiki, like MoinMoin, and it is written
+in Python.
+
+== Features ==
+
+ * Git versioned backend
+ * Interfaces with Gitweb for history browsing, RSS...
+ * Consistent use of CSS for easy theming
+ * Pluggable macros
+ * Page includes (templates with parameters coming)
+ * Usable for blogging
+ * Directory listing
+ * [[Picture]] gallery
+ * Easy to interface with other SCMs through a glue script
+ * User accounts supported through HTTP basic auth done by web server
+ * Per-page ACLs
+ * Simple title and full text search
+ * GuruMeditation alerts :-)
+
+==== Download ====
+
+===== Source repository ====
+
+You can obtain the latest source snapshot through git:
+
+{{{
+git clone http://www.codewiz.org/~bernie/git/geekigeeki.git/
+git clone git://www.codewiz.org/~bernie/geekigeeki.git/
+}}}
+
+===== Revision history =====
+
+Browse it online with GitWeb: http://www.codewiz.org/wikigit/geekigeeki.git
+
+===== Individual source files =====
 
-The modified source code is available here:
  * [[../wikidata/geekigeeki.py      | geekigeeki.py]]      -- The CGI itself
  * [[../wikidata/geekigeeki.conf.py | geekigeeki.conf.py]] -- Sample site config
  * [[../wikidata/geekigeeki.css     | geekigeeki.css]]     -- The stylesheet used at this site
  * [[../wikidata/post_edit_hook.sh  | post_edit_hook.sh]]  -- Some glue to integrate with git
  * [[../wikidata/wiki_apache.conf   | wiki_apache.conf]]   -- Sample conf file for Apache
 
+==== Installation ====
+
+The easiest way is:
+
+ * clone the git repository anywhere you like
+ * edit **wiki_apache.conf** to adapt it to your system, and move or link it to your Apache configuration directory.
+ * customize the wiki through geekigeeki.conf.py
+ * create a git repository for your wiki:
+ {{{
+ mkdir data
+ cd data
+ git init --shared=group
+ chgrp -R apache .
+ }}}
+ * reload Apache
+
+==== Update procedure ====
+
+If you cloned the repository as suggested, updating and downgrading is easy:
+
+{{{
+git pull
+}}}
+
+to switch to a different version of GeekiGeeki:
+
+{{{
+git checkout {tree-ish}
+}}}
+
 ==== Contributing ====
 
 Please send your patches!  See the GeekiGeekiToDo list for ideas.
 
-Bugfixes and cute hacks welcome.  BloatWare ''will'' be rejected: this is a minimalistic wiki, damn'it!
+Bugfixes and cute hacks welcome.  BloatWare //will// be rejected: this is
+a minimalistic wiki, damn'it!