read filenames from cli
[surrogator.git] / README.rst
1 **********
2 Surrogator
3 **********
4
5 Open source Libravatar__ compatible avatar image server written in PHP.
6
7 __ http://wiki.libravatar.org/api/
8
9
10
11 Steps
12 =====
13
14 1. Put images in ``raw/`` folder.
15    Name has to be email address + image file extension, for example
16    ``foo@example.org.png``.
17 2. Generate/update big square files.
18 3. Generate images for each size that is defined in ``$sizes``.