1.1 --- a/README.txt Tue Sep 10 15:22:51 2013 +0000
1.2 +++ b/README.txt Tue Sep 10 16:08:07 2013 +0000
1.3 @@ -63,20 +63,35 @@
1.4 Height: 176 pixels
1.5
1.6 An image preparation program then needs to be run on a list of image filenames
1.7 -to produce suitable source files incorporated into the built program. This is
1.8 -done as follows:
1.9 +to produce suitable source files that can be incorporated into the built
1.10 +program. To save you the effort, such files are included pre-built in the
1.11 +distribution of this software, meaning that you can skip forward to the
1.12 +"Building the Software" section, but to use other images you will need to
1.13 +consult the following instructions.
1.14
1.15 -python tools/bitmap.py images file1.png file2.png file3.png
1.16 +A suitable image preparation program can be found in the tools directory and
1.17 +is called bitmap.py. This program is written in Python and needs the Python
1.18 +Imaging Library, available in Debian as the python-imaging package and in
1.19 +other GNU/Linux distributions under other names. It is also available from the
1.20 +following location:
1.21
1.22 -Here, three PNG files are loaded, internally converted (the files are not
1.23 +https://pypi.python.org/pypi/PIL
1.24 +
1.25 +To get you started, some example images are provided in the examples
1.26 +directory, and these images are prepared for the program as follows:
1.27 +
1.28 +python tools/bitmap.py images examples/*.JPG
1.29 +
1.30 +Here, three JPEG files are loaded, internally converted (the files are not
1.31 changed), and the bitmap data written out to two files:
1.32
1.33 images.c
1.34 images.h
1.35
1.36 -Since the Makefile and epaper program references these files, it is
1.37 -recommended that the "images" basename be retained when running the bitmap.py
1.38 -program.
1.39 +Since the Makefile and epaper program reference these files, it is recommended
1.40 +that the "images" basename be retained when running the bitmap.py program.
1.41 +
1.42 +The bitmap.py program also supports other common image formats such as PNG.
1.43
1.44 Building the Software
1.45 ---------------------