aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst52
1 files changed, 49 insertions, 3 deletions
diff --git a/README.rst b/README.rst
index df79148..a9d9b34 100644
--- a/README.rst
+++ b/README.rst
@@ -1,5 +1,51 @@
-Pelican themes
+Pelican Themes
##############
-This repository contains themes for pelican, feel free to clone, add you own
-and make a pull request, it's community-managed!
+This repository contains themes for Pelican. Feel free to clone, add your own
+theme, and submit a pull request. It's community-managed!
+
+Using Themes
+############
+
+These instructions assume you have already completed the `Getting Started`_
+guide, have a working site, and would now like to apply a non-default theme.
+
+.. _Getting Started: http://docs.getpelican.com/en/latest/getting_started.html
+
+First, choose a location to hold your themes. For this example, we'll use the
+directory ``~/pelican-themes``, but yours could be different. Clone the
+``pelican-themes`` repository to that location on your local machine:
+
+.. code-block:: sh
+
+ git clone --recursive https://github.com/getpelican/pelican-themes ~/pelican-themes
+
+Now you should have your ``pelican-themes`` repository stored at
+``~/pelican-themes/``.
+
+To use one of the themes, edit your Pelican settings file to include this line:
+
+.. code-block:: python
+
+ THEME = "/home/user/pelican-themes/theme-name"
+
+So, for instance, to use the ``mnmlist`` theme, you would edit your settings
+file to include:
+
+.. code-block:: python
+
+ THEME = "/home/user/pelican-themes/mnmlist"
+
+Save the changes to your settings file and then regenerate your site by using
+the Makefile you should already have set up using ``pelican-quickstart``:
+
+.. code-block:: sh
+
+ make html
+
+Themes can also be specified directly via the ``-t ~/pelican-themes/theme-name``
+parameter to the ``pelican`` command. If you want to edit your theme, make sure
+that any edits you make are made to the copy stored in
+``~/pelican-themes/theme-name``. Any changes made to
+files stored in your site's ``output`` directory will be deleted the next
+time you generate your site.