diff options
| author | Justin Mayer <entroP@gmail.com> | 2013-07-21 10:07:01 -0700 |
|---|---|---|
| committer | Justin Mayer <entroP@gmail.com> | 2013-07-21 10:07:01 -0700 |
| commit | accfa0ac97186607c701347a55d43b6c59f9947f (patch) | |
| tree | dc57b3b3e83453958896f2884ce781a886788edb | |
| parent | c9254ce7f83ea7e765bfcdad16f35e5c9394137d (diff) | |
| download | pelican-themes-accfa0ac97186607c701347a55d43b6c59f9947f.tar.gz | |
Clarify Syte theme dependencies. Fixes #109.
| -rw-r--r-- | syte/README.md | 27 |
1 files changed, 19 insertions, 8 deletions
diff --git a/syte/README.md b/syte/README.md index bae5417..b8bd6d4 100644 --- a/syte/README.md +++ b/syte/README.md @@ -1,12 +1,26 @@ Syte theme for Pelican ====================== -This theme is based on [Syte][syte] and is for Pelican. It has been instanciated by [samrat][samrat] and continued by [arnaudbos][arnaudbos]. +This Pelican theme is based on [Syte][syte]. It was created by [samrat][samrat], with continued development by [arnaudbos][arnaudbos]. You can [see this theme in action here][sneakernet].  + +Dependencies +------------ + +Pelican-Syte uses the `webassets` and `cssmin` Python packages, which can be installed via: + + pip install webassets cssmin + +Also required is the [assets][] Pelican plugin, which integrates the `webassets` +package mentioned above into Pelican. Follow the instructions on the +[Pelican Plugins][] page to install the [assets][] plugin and activate it via +your settings file. + + Settings -------- @@ -19,12 +33,6 @@ All these settings are optional, not using them will simply not enable the socia * SITE_DESCRIPTION = u'Used in HTML meta tag for description' * SITE_KEYWORDS = u'Used in the HTML meta tag for keywords' -###### Not so optional - -Pelican-syte uses the webassets module integrated into Pelican, so you -will also need to install it ( `pip install webassets` ) and add the -`pelican.plugins.assets` plugin to `PLUGINS` setting. - #### Links * DISPLAY_HOME_ON_MENU = True (If you still want to display a 'Home' link, note that the site name is already a link to the home page) @@ -55,7 +63,10 @@ will also need to install it ( `pip install webassets` ) and add the * INSTAGRAM_USERNAME = 'your_username' (Needed if INSTAGRAM_INTEGRATION_ENABLED is set to True) * INSTAGRAM_API_ACCESS = 'your_api_access_key' (Needed if INSTAGRAM_INTEGRATION_ENABLED is set to True) + [syte]: http://rigoneri.github.com/syte/ -[samrat]: http://samrat.github.com +[samrat]: http://samrat.github.com/ [arnaudbos]: http://github.com/arnaudbos/ [sneakernet]: http://www.sneakernet.fr/ +[assets]: https://github.com/getpelican/pelican-plugins/tree/master/assets +[Pelican Plugins]: https://github.com/getpelican/pelican-plugins |