diff options
author | p4bl0 <pablo@rauzy.name> | 2010-07-23 02:52:43 +0200 |
---|---|---|
committer | p4bl0 <pablo@rauzy.name> | 2010-07-23 02:52:43 +0200 |
commit | 4467a42aee94c85868fc4c706669fcf89707bce3 (patch) | |
tree | 124141fe17638b2fb35654b25c67467fde69bf80 /README | |
parent | 316be9ffd60a63bdac67f1c944507dde1b4a55c8 (diff) |
Adding files to the projects
Makefile is still empty but not for long I hope.
README starts to be something real.
src/archives.html is the templates for the archives page.
src/exclude is for .git/info/exclude
src/install.sh is the main script which will include other when generating
fugitive.
src/post-receive.sh is still empty for now.
Diffstat (limited to 'README')
-rw-r--r-- | README | 66 |
1 files changed, 66 insertions, 0 deletions
@@ -0,0 +1,66 @@ +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 +======= + +Simply run `fugitive --install <dir>`. +This will create the git repos with appropriate hooks and files in <dir>. +If <dir> isn't specified then the current working directory is used. + +NOTE: You need to use the same process to install remote repository. + + +UPDATE +====== + +Simply run `fugitive --install-hooks <dir>`. +This will only (re)install fugitive hooks scripts. +If <dir> isn't specified then the current working directory is used. + + +CONFIGURATION +============= + +There are three item in the "fugitive" section of the git config: + + - "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 "fugitive/articles". This path is relative to the root of + the git repository, must be in it and must not start with ".". + + - "templates-dir" is the path where fugitive will look for templates files. + Default value is "fugitive/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. + + +USAGE +===== + +General use +----------- + + +Template system +--------------- + + +IDEA +==== + +* make devrait gzippé puis base64 encodé les fichiers pour les mettres dans le + script d'install, et l'help aussi. + +* index = cp de last article. + +* trouver moyen de mettre des prev et next dans la nav |