Browse Source

Fixed installation guide

main
Lakshmi Vyasarajan 14 years ago
parent
commit
39a086fd2b
3 changed files with 12 additions and 5 deletions
  1. +6
    -3
      docs/install.html
  2. +5
    -2
      hyde/layouts/doc/content/install.html
  3. +1
    -0
      setup.py

+ 6
- 3
docs/install.html View File

@@ -57,7 +57,7 @@
<h3 class="subtitle">PIPing hot hyde</h3>
</hgroup>
<p>Installing hyde is as simple as running the following&nbsp;command:</p>
<div class="code"><div class="highlight"><pre>pip install -e https://github.com/hydepy/hyde#egg<span class="o">=</span>hyde<br /></pre></div><br /></div>
<div class="code"><div class="highlight"><pre>pip install -e git://github.com/hydepy/hyde.git#egg<span class="o">=</span>hyde<br /></pre></div><br /></div>

<p>However, based on your choice and use of plugins you may need to install
additional packages. The requirements for each plugin is outlined in the
@@ -65,7 +65,8 @@ corresponding <a href="/plugins">plugin documentation</a>.</p>
<h2 id="essential_requirements">Essential&nbsp;Requirements</h2>
<p>While your mileage may vary, I consider the following to be essential for
generating a static website with hyde. These are a part of the requirements
file and the above command will download and install them as part of&nbsp;hyde.</p>
file and the above command will download and install most of them as part
of&nbsp;hyde.</p>
<p>It is also recommended that you use <a href="http://mathematism.com/2009/07/30/presentation-pip-and-virtualenv/">virtualenv</a> to separate the hyde
environment from other python projects. Note that installing hyde using
pip would install all of the below. However, if you&#8217;d like finer grained
@@ -82,7 +83,9 @@ control over the packages, you can install these&nbsp;individually:</p>
<li><code>Pyyaml</code>: Much of hyde&#8217;s [configuration] is done using&nbsp;yaml.</li>
<li><code>Typogrify</code>: Typogrify automatically fixes and enhances the typographical
accuracy of your content. While this is not a technical requirement for
hyde, it is absolutely essential to create good looking&nbsp;content.</li>
hyde, it is absolutely essential to create good looking content. Note that
this is not installed as part of the above package and must be installed
separately. This will be rectified in the&nbsp;future.</li>
</ol>
<div class="code"><div class="highlight"><pre>pip install argparse<br />pip install commando<br />pip install jinja2<br />pip install markdown<br />pip install pyyaml<br />pip install -e https://github.com/hydepy/typogrify#egg<span class="o">=</span>typogrify<br /></pre></div><br /></div>



+ 5
- 2
hyde/layouts/doc/content/install.html View File

@@ -22,7 +22,8 @@ corresponding [plugin documentation][plugins].

While your mileage may vary, I consider the following to be essential for
generating a static website with hyde. These are a part of the requirements
file and the above command will download and install them as part of hyde.
file and the above command will download and install most of them as part
of hyde.

It is also recommended that you use [virtualenv][] to separate the hyde
environment from other python projects. Note that installing hyde using
@@ -40,7 +41,9 @@ control over the packages, you can install these individually:
5. `Pyyaml`: Much of hyde's [configuration] is done using yaml.
6. `Typogrify`: Typogrify automatically fixes and enhances the typographical
accuracy of your content. While this is not a technical requirement for
hyde, it is absolutely essential to create good looking content.
hyde, it is absolutely essential to create good looking content. Note that
this is not installed as part of the above package and must be installed
separately. This will be rectified in the future.
~~~sh~~~
pip install argparse
pip install commando


+ 1
- 0
setup.py View File

@@ -14,6 +14,7 @@ setup(name='hyde',
'jinja2',
'pyYAML',
'markdown',
'smartypants',
'pygments'
),
scripts=['main.py'],


Loading…
Cancel
Save