From 24bf360fb6500cc8c677d3c424486f4f58ff5d47 Mon Sep 17 00:00:00 2001 From: James Darnley Date: Tue, 25 Feb 2014 00:54:03 +0100 Subject: README: various grammar, spelling, or typo fixes Conflicts: README --- README | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README b/README index a71f9b1..735c7a8 100644 --- a/README +++ b/README @@ -32,11 +32,11 @@ fugitive: README

Create a blog

- There's two install mode for fugitive: local and remote. The local mode + There are two install modes for fugitive: local and remote. The local mode should be used to install a repository where you edit your blog, and the remote mode for a repository to which you're going to push to publish your blog.
- The local mode can also be used to publish if you edit your file directly on + The local mode can also be used to publish if you edit your files directly on your server.

@@ -44,7 +44,7 @@ fugitive: README fugitive --install-mode <dir>, where mode is either "local" or "remote".
- This will create the git repos with appropriate hooks, config and files in + This will create a git repository with appropriate hooks, config and files in <dir>.
If <dir> isn't specified then the current working directory is used. @@ -58,7 +58,7 @@ fugitive: README

Configuration

- All this settings are in the "fugitive" section of the git config. + All these 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: @@ -66,9 +66,9 @@ fugitive: README

blog-url
- This is the public url of the generated blog. You need to set + 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). + used in the default footer template).
public-dir*
@@ -105,9 +105,9 @@ fugitive: README

General use

- Article you want to publish should be file without the .html extension in the + Articles you want to publish should be a file without the .html extension in the articles-dir directory (see configuration). - The first line of the file will be used as title and the rest of the file as + The first line of the file will be used as a title and the rest of the file as the content of the article.

@@ -164,7 +164,7 @@ fugitive: README more accurate than xml comments (<!-- var -->).

- In addition to variable rendering, there are a conditional and a foreach loop + In addition to variable rendering, there is a conditional and a foreach loop constructs, plus an include directive.

@@ -180,14 +180,14 @@ fugitive: README available, the loops are processed right after the includes.

- The syntax of the conditional construct is as follow: + The syntax of the conditional construct is as follows: 

<?fugitive ifset:var ?>
   Template code which is ignored if var value is empty, and
   which typically includes <code><?fugitive var ?></code>.
 <?fugitive endifset:var ?>

- Not every variables can be used in the conditional construct, it is indicated + Not every variable can be used in the conditional construct, this is indicated in the description of those which can't.

The following variables are available everywhere:

@@ -200,7 +200,7 @@ fugitive: README
blog_url
- the blog-url value in the "fugitive" section of the git + The blog-url value in the "fugitive" section of the git configuration (see configuration).
commit_Hash
@@ -268,7 +268,7 @@ fugitive: README (re)generation of the file but formatted to be file name friendly.
-

Variables specific to the article.html templates:

+

Variables specific to the article.html template:

article_title
@@ -373,7 +373,7 @@ fugitive: README

foreach loops in archives.html and feed.xml:

Two foreach loops are available: foreach:article - and foreach:commit. The syntax is as follow: + and foreach:commit. The syntax is as follows: 

<?fugitive foreach:article ?>
   Template code that will be repeated for each article and
-- 
cgit v1.2.3