More documentation

This commit is contained in:
Stefan Ritter 2009-12-07 01:51:35 +01:00
parent e7d313cdc4
commit ecd758e7f1
1 changed files with 56 additions and 11 deletions

67
README
View File

@ -1,13 +1,58 @@
Index: Index:
1) Entries 1) Installation
2) Staticpages 1.1) Apache
3) Comments 1.2) Lighttpd
4) Linklist 2) Entries
3) Staticpages
4) Comments
5) Linklist
1) Entries 1) Installation
===============
The installation of Blogthon assumes that your httpd supports CGI and Python
is installed. If all this is given, you can download Blogthon in a directory
of your choice. After that you have to symlink 2 files into your www directory:
* blogthon.cgi
* styles
Then create 3 directories and 1 empty file:
* entries/
* static/
* plugins/
* linklist
Now copy the example configuration into your www directory, or to
../blogthonrc or ../.blogthonrc.
If all this is done, you can continue with setting up your httpd.
1.1) Apache
===========
To enable CGI you just have to run 'a2enmod cgi' as root. Now put something
like this in /etc/apache2/sites-available/default:
<Directory /this/is/where/your/www/root/is/>
Options +ExecCGI
AddHandler cgi-script .cgi
DirectoryIndex blogthon.cgi
</Directory>
To finish the installation, reload Apache with
'/etc/init.d/apache2 force-reload' as root.
1.2) Lighttpd
=============
Coming soon...
2) Entries
==========
To start blogging you just have to open your favorite editor, write your entry To start blogging you just have to open your favorite editor, write your entry
and save it under entries/. The filename should be like this: and save it under entries/. The filename should be like this:
(entry title).(suffix) (entry title).(suffix)
@ -24,8 +69,8 @@ workaround I use a small shellscript instead of starting vim/emacs/...:
http://git.fucktheforce.de/?p=xeno;a=blob_plain;f=viod;hb=HEAD http://git.fucktheforce.de/?p=xeno;a=blob_plain;f=viod;hb=HEAD
2) Staticpages 3) Staticpages
==============
Staticpages are placed under static/ without a suffix. To sort them, you can Staticpages are placed under static/ without a suffix. To sort them, you can
start the filename with a literal and -. So '01-Foo' will be placed before start the filename with a literal and -. So '01-Foo' will be placed before
'02-Bar'. '02-Bar'.
@ -35,8 +80,8 @@ to place the following content in the first line:
extern_link: http://your/link. extern_link: http://your/link.
3) Comments 4) Comments
===========
Comments are saved under entries/ like all entries, but with the suffix Comments are saved under entries/ like all entries, but with the suffix
'.comments'. The syntax in this file is like this: '.comments'. The syntax in this file is like this:
@ -46,8 +91,8 @@ Comments are saved under entries/ like all entries, but with the suffix
.more text .more text
4) Linklist 5) Linklist
===========
To add a link to your linklist, just add a line to the linklist file: To add a link to your linklist, just add a line to the linklist file:
http://some/link name of your link http://some/link name of your link