From 81fa7bd8b6a632a77ccf6267bbd06b4ebfa06594 Mon Sep 17 00:00:00 2001
From: p4bl0
Date: Sun, 25 Jul 2010 18:52:35 +0200
Subject: now generating rss feed too
---
README | 90 ++++++++++++++++++++++++++++++++++++++----------------------------
1 file changed, 52 insertions(+), 38 deletions(-)
(limited to 'README')
diff --git a/README b/README
index 39a7d38..8a3a5f0 100644
--- a/README
+++ b/README
@@ -1,12 +1,12 @@
fugitive README file
-Info
+Info
fugitive is a blog engine running on top of git using hooks to generate
static html pages and thus having only git as dependency.
-Install
+Install
Build
@@ -28,9 +28,14 @@ fugitive README file
<dir>.
If <dir> isn't specified then the current working directory is used.
-
-
- NOTE: You need to use the same process to install any remote
+
+
+ Once you have installed your blog you need to set the blog-url
+ parameter in your git configuration. See configuration
+ for details.
+
+
+ You need to use the same process to install any remote
repository where you'd like to push your blog.
Update
@@ -40,42 +45,52 @@ fugitive README file
If <dir> isn't specified then the current working directory is used.
-Configuration
+Configuration
- There are three paths in the "fugitive" section of the git config:
+ All this settings are in the "fugitive" section of the git config.
+ You can change them with the command git config
+ fugitive.parameter value
, where parameter
+ is one of the following:
-
- -
- public-dir is the path to the directory that will contain the
- generated html files. Defautlt value is ".", the root of the git
- repository. You could set it to "blog" for instance if you
- already have a static website under your git repos.
-
- -
- articles-dir is the path where fugitive will look for published
- articles. Default value is "_articles". This path is relative to
- the root of the git repository, must be in it and must not start with
- ".".
-
- -
- templates-dire is the path where fugitive will look for templates
- files. Default value is "_templates". This path is relative to
- the root of the git repository, must be in it and must not start with
- ".".
-
-
-
- NOTE: You must NOT put a trailing '/' at the end of any of
- those paths.
-
-
- If you want your article to be preprocessed by an external tool (markdown,
- textile...) you need to set preproc to a command line that will read
- on stdin and write to stdout.
+
+ - blog-url
+ -
+ This is the public url of the generated blog. You need to set
+ it as soon as possible since it's required for the RSS feed (and
+ used in the default template's footer).
+
+ - public-dir
+ -
+ This is the path to the directory that will contain the generated html
+ files. Defautlt value is ".", the root of the git repository. You
+ could set it to "blog" for instance if you already have a static
+ website under your git repos.
+
+ - articles-dir
+ -
+ This is the path where fugitive will look for published articles. Default
+ value is "_articles". This path is relative to the root of the
+ git repository, must be in it and must not start with ".".
+
+ - templates-dire
+ -
+ This is the path where fugitive will look for templates files. Default
+ value is "_templates". This path is relative to the root of the
+ git repository, must be in it and must not start with ".".
+
+ - preproc
+ -
+ If you want your article to be preprocessed by an external tool (markdown,
+ textile...) you need to set preproc to a command line that will
+ read on stdin and write to stdout.
+
+
+
+ You must NOT put a trailing '/' at the end of any of the path.
-Usage
+Usage
General use
@@ -86,8 +101,7 @@ fugitive README file
The first line of the file will be used as title and the rest of the file as
the content.
-
- /!\ WARNINGS:
+
DO NOT CREATE AN ARTICLE FILE NAMED "archives".
DO NOT CREATE AN ARTICLE FILE NAMED "index".
--
cgit v1.2.3