forks/sigal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update changelog and doc.

Browse Source
This commit is contained in:
Simon Conseil
2013-12-26 17:59:57 +01:00
parent efcd60416c
commit e46c8d5b12
5 changed files with 28 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/getting_started.rst
View File

@@ -14,11 +14,11 @@ Init
Build
After adapting the configuration to your needs, put your images in
a sub-directory (``pictures`` by default) and run ``sigal build <your images
directory>``. 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.
a sub-directory and run ``sigal build <your images directory>``. 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 (resp.
videos) that are smaller than the size specified by the ``img_size`` (resp.
``video_size``) setting will not be resized.
Serve
To visualize your gallery, you can use ``sigal serve`` which runs a basic
@@ -33,7 +33,7 @@ Help of the ``sigal build`` command
::
$ sigal build [-h] [-d] [-v] [-f] [-c CONFIG] [-t THEME]
$ sigal build [-h] [-d] [-v] [-f] [-c CONFIG] [-t THEME] [-n NCPU]
[source] [destination]
Required arguments:
@@ -64,3 +64,6 @@ Optional arguments:
``-t THEME, --theme THEME``
Specify a theme directory, or a theme name for the themes included with Sigal
``-n NCPU, --ncpu NCPU``
Number of cpu to use (default: all)