diff --git a/README.md b/README.md index 45575c3..69b3bd0 100644 --- a/README.md +++ b/README.md @@ -2,15 +2,27 @@ siglican ======== A static gallery generator plugin for Pelican, based on the Sigal -Colorbox/Galleria generator by Simon Conseil. +Colorbox/Galleria static site generator. ##How To -1. Create a 'siglican' directory in your base directory (at the same level - as 'content'. -2. Create an 'images' directory under siglican. Folders under this level are - albums. +1. Put the contents of this folder into your Pelican plugins directory. Add + 'siglican' to PLUGINS in pelicanconf.py. +2. Create a 'siglican' directory in your base directory, at the same level as + 'content'. Drag 'colorbox' or 'galleria' from the 'themes' directory into + this folder. Also create an 'images' subdirectory under 'siglican'. + + /site + /content/* + /plugins/siglican + /siglican + /images + /album1 + /album2 + /... + /theme + 3. Create album and image metadata, as desired. -4. Create theme directory inside of 'siglican'. Use the colorbox or galleria +5. Create theme directory inside of 'siglican'. Use the colorbox or galleria theme as a starting point. Make sure that your Pelican theme's base.html template has a 'head' block defined before . @@ -19,8 +31,9 @@ Colorbox/Galleria generator by Simon Conseil. 2. Change settings names to something other than SIGAL_* 3. Unit tests. 4. Logging cleanup. -5. General code and documentation cleanup. +5. Update colorbox/galleria example themes to deal better with nested albums. +6. General code and documentation cleanup. ##Credits -* The bulk of the code is ported from [Sigal v0.8.0](http://sigal.saimon.org/). +* The bulk of the code is ported from [Sigal v0.8.0](http://sigal.saimon.org/) by Simon Conseil. * Pelican integration by Scott Boone (sawall@github). \ No newline at end of file