From da8530159eec5c73da8cf35e93a687b608737c16 Mon Sep 17 00:00:00 2001 From: Simon Conseil Date: Fri, 6 Sep 2013 00:33:47 +0200 Subject: [PATCH] Update docs --- README.rst | 2 +- docs/changelog.rst | 7 ++++--- docs/getting_started.rst | 17 ++++++++++------- 3 files changed, 15 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index e806a25..4dedc16 100644 --- a/README.rst +++ b/README.rst @@ -11,7 +11,7 @@ and it allows to build a static gallery of images with the following features: * Process directories recursively. * Generate HTML pages using jinja2 templates. * Relative links for a portable output. -* Themes support. +* Support themes, videos, EXIF tags, zip download. * MIT licensed. The idea behind Sigal is to ease the use of the javascript librairies like diff --git a/docs/changelog.rst b/docs/changelog.rst index 9a9e6f0..940d4f0 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -2,10 +2,10 @@ Changelog =========== -Version 0.5.0-dev -~~~~~~~~~~~~~~~~~ +Version 0.5.0 +~~~~~~~~~~~~~ -Released on 2013-xx-xx. +Released on 2013-09-06. - Add support for videos. Videos are encoded to webm (see the ``webm_options`` setting). @@ -17,6 +17,7 @@ Released on 2013-xx-xx. - Correct themes design with long directory names. - Add the possibility to adjust images after resizing (with the Adjust processor from Pilkit). See the ``adjust_options`` setting. +- Add the possibility to disable image resizing. Version 0.4.1 ~~~~~~~~~~~~~ diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 1f5d4f3..002a86d 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -7,15 +7,18 @@ How to Use Init To get started, just run ``sigal init`` which will copy an example - configuration file in the current directory. All configuration values have a - default; values that are commented out serve to show the default. Default - values are specified when modified in this example config file. + :doc:`configuration file ` in the current directory. All + configuration values have a default; values that are commented out serve to + show the default. Default values are specified when modified in this example + config file. Build - After adapting the configuration to your needs, put your images in a - sub-directory and run ``sigal build ``. The next time - you run ``sigal build``, only the new images will be processed. Use the - ``-f`` flag to force the reprocessing of all the images. + After adapting the configuration to your needs, put your images in + a sub-directory (``pictures`` by default) and run ``sigal build ``. The next time you run ``sigal build``, only the new images will + be processed. Use the ``-f`` flag to force the reprocessing of all the + images. Images that are smaller than the size specified by the ``img_size`` + setting will not be resized. Serve To visualize your gallery, you can use ``sigal serve`` which runs a basic