summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJames Darnley <james.darnley@gmail.com>2014-02-25 00:54:03 +0100
committerp4bl0 <r@uzy.me>2014-08-19 21:15:04 +0200
commit24bf360fb6500cc8c677d3c424486f4f58ff5d47 (patch)
tree099fe1361ec60be8d9e4e3a281be46cb4d816271
parentf5333ff7e8aee4d85c3c357555feb6a2d504aa3e (diff)
README: various grammar, spelling, or typo fixes
Conflicts: README
-rw-r--r--README28
1 files 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
</p>
<h3 id="create">Create a blog</h3>
<p>
- 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.<br />
- 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.
</p>
<p>
@@ -44,7 +44,7 @@ fugitive: README
<code>fugitive --install-<em>mode</em> &lt;dir&gt;</code>,
where <em>mode</em> is either &quot;local&quot; or &quot;remote&quot;.
<br />
- 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
&lt;dir&gt;.
<br />
If &lt;dir&gt; isn't specified then the current working directory is used.
@@ -58,7 +58,7 @@ fugitive: README
<h2 id="config">Configuration</h2>
<p>
- All this settings are in the &quot;fugitive&quot; section of the git config.
+ All these settings are in the &quot;fugitive&quot; section of the git config.
You can change them with the command <br />
<code>git config fugitive.<em>parameter</em> <em>value</em></code>,
where <em>parameter</em> is one of the following:
@@ -66,9 +66,9 @@ fugitive: README
<dl>
<dt>blog-url</dt>
<dd>
- This is the public url of the generated blog. <strong>You need to set
+ This is the public URL of the generated blog. <strong>You need to set
it</strong> 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).
</dd>
<dt>public-dir*</dt>
<dd>
@@ -105,9 +105,9 @@ fugitive: README
<h3 id="general-use">General use</h3>
<p>
- 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
<em>articles-dir</em> directory (see <a href="#config">configuration</a>).
- 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.
</p>
<p>
@@ -164,7 +164,7 @@ fugitive: README
more accurate than xml comments (<code>&lt;!-- <em>var</em> --&gt;</code>).
</p>
<p>
- 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.
</p>
<p>
@@ -180,14 +180,14 @@ fugitive: README
available, the loops are processed right after the includes.
</p>
<p>
- The syntax of the conditional construct is as follow:
+ The syntax of the conditional construct is as follows:
</p>
<pre>&lt;<span class="keyword">?fugitive</span> ifset:<em>var</em> ?&gt;
Template code which is ignored if <em>var</em> value is empty, and
which typically includes &lt;<span class="function-name">code</span>&gt;&lt;<span class="keyword">?fugitive</span> <em>var</em> ?&gt;&lt;/<span class="function-name">code</span>&gt;.
&lt;<span class="keyword">?fugitive</span> endifset:<em>var</em> ?&gt;</pre>
<p class="note">
- 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.
</p>
<p>The following variables are available everywhere:</p>
@@ -200,7 +200,7 @@ fugitive: README
</dd>
<dt>blog_url</dt>
<dd>
- the <em>blog-url</em> value in the &quot;fugitive&quot; section of the git
+ The <em>blog-url</em> value in the &quot;fugitive&quot; section of the git
configuration (see <a href="#config">configuration</a>).
</dd>
<dt>commit_Hash</dt>
@@ -268,7 +268,7 @@ fugitive: README
(re)generation of the file but formatted to be file name friendly.
</dd>
</dl>
-<h4>Variables specific to the article.html templates:</h4>
+<h4>Variables specific to the article.html template:</h4>
<dl>
<dt>article_title</dt>
<dd>
@@ -373,7 +373,7 @@ fugitive: README
<h4>foreach loops in archives.html and feed.xml:</h4>
<p>
Two foreach loops are available: <code>foreach:article</code>
- and <code>foreach:commit</code>. The syntax is as follow:
+ and <code>foreach:commit</code>. The syntax is as follows:
</p>
<pre>&lt;<span class="keyword">?fugitive</span> foreach:article ?&gt;
Template code that will be repeated for each article and