From 39a086fd2bc0cd054702a1c0f87b8f288e7b09c6 Mon Sep 17 00:00:00 2001 From: Lakshmi Vyasarajan Date: Thu, 27 Jan 2011 12:19:24 +0530 Subject: [PATCH] Fixed installation guide --- docs/install.html | 9 ++++++--- hyde/layouts/doc/content/install.html | 7 +++++-- setup.py | 1 + 3 files changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/install.html b/docs/install.html index a608e68..aba9164 100644 --- a/docs/install.html +++ b/docs/install.html @@ -57,7 +57,7 @@

PIPing hot hyde

Installing hyde is as simple as running the following command:

-
pip install -e https://github.com/hydepy/hyde#egg=hyde

+
pip install -e git://github.com/hydepy/hyde.git#egg=hyde

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 plugin documentation.

Essential Requirements

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 pip would install all of the below. However, if you’d like finer grained @@ -82,7 +83,9 @@ control over the packages, you can install these individually:

  • Pyyaml: Much of hyde’s [configuration] is done using yaml.
  • 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. 
    pip install argparse
    pip install commando
    pip install jinja2
    pip install markdown
    pip install pyyaml
    pip install -e https://github.com/hydepy/typogrify#egg=typogrify

    diff --git a/hyde/layouts/doc/content/install.html b/hyde/layouts/doc/content/install.html index d21a8c4..65a0638 100644 --- a/hyde/layouts/doc/content/install.html +++ b/hyde/layouts/doc/content/install.html @@ -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 diff --git a/setup.py b/setup.py index 86b4d67..29f4edd 100644 --- a/setup.py +++ b/setup.py @@ -14,6 +14,7 @@ setup(name='hyde', 'jinja2', 'pyYAML', 'markdown', + 'smartypants', 'pygments' ), scripts=['main.py'],