1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/README.txt Sat Oct 10 18:44:54 2015 +0200
1.3 @@ -0,0 +1,96 @@
1.4 +Introduction
1.5 +============
1.6 +
1.7 +PaletteOptimiser is a tool for converting images to the eight colours
1.8 +supported on the 8-bit Acorn microcomputers: black, white, and the primary and
1.9 +secondary colours. It then chooses four of these colours per horizontal line
1.10 +of each eight-colour image, permitting such images to be displayed in
1.11 +four-colour modes with palette switching on a line-by-line basis.
1.12 +
1.13 +Usage
1.14 +=====
1.15 +
1.16 +optimiser.py <input filename> <output filename> [ <options> ]
1.17 +
1.18 +Run the program with the --help argument to see a description of the options:
1.19 +
1.20 +optimiser.py --help
1.21 +
1.22 +Dependencies
1.23 +============
1.24 +
1.25 +Apart from Python, this software requires the following:
1.26 +
1.27 +Packages Release Information
1.28 +-------- -------------------
1.29 +
1.30 +Python Imaging Library Debian package: python-imaging
1.31 +(PIL) (Tested with 1.1.7-4+deb7u1)
1.32 + Source: http://www.effbot.org/zone/pil-index.htm
1.33 +
1.34 +exif-py Debian package: python-exif
1.35 + (Tested with 1.0.8-3)
1.36 + Source: https://github.com/ianare/exif-py
1.37 +
1.38 +The following optional dependencies apply for compilation with Shedskin:
1.39 +
1.40 +Packages Release Information
1.41 +-------- -------------------
1.42 +
1.43 +Shedskin Debian package: shedskin
1.44 + (Tested with 0.9.2-2)
1.45 + Source: http://code.google.com/p/shedskin/
1.46 +
1.47 +g++ Debian package: g++
1.48 + (Tested with 4:4.7.2-1)
1.49 + Source: https://gcc.gnu.org/
1.50 +
1.51 +make Debian package: make
1.52 + (Tested with 3.81-8.2)
1.53 + Source: https://www.gnu.org/software/make/
1.54 +
1.55 +Compilation with Shedskin
1.56 +=========================
1.57 +
1.58 +Suitable versions of the code (see the simpleimage-shedskin branch below) can
1.59 +be compiled with the Shedskin Python-to-C++ compiler for additional
1.60 +performance gains. This is done as follows:
1.61 +
1.62 +shedskin -e optimiserlib.py
1.63 +make
1.64 +
1.65 +A file called optimiserlib.so should be produced which should then behave just
1.66 +like the original Python version, at least when used with the optimiser.py
1.67 +program.
1.68 +
1.69 +Repository Branches
1.70 +===================
1.71 +
1.72 +The default branch is the original development branch where new techniques
1.73 +have been introduced.
1.74 +
1.75 +The simpleimage branch introduces an alternative image class so that the image
1.76 +processing routines need not be tightly coupled with the Python Imaging
1.77 +Library abstractions.
1.78 +
1.79 +The simpleimage-shedskin branch takes advantage of the simpleimage branch to
1.80 +define a separate module that can be compiled using the Shedskin Python-to-C++
1.81 +compiler. The resulting compiled module enables an approximate four-fold
1.82 +increase in speed.
1.83 +
1.84 +The shedskin branch is an obsolete and not particularly effective attempt to
1.85 +try and get an earlier version of the tool to compile using Shedskin.
1.86 +
1.87 +Contact, Copyright and Licence Information
1.88 +==========================================
1.89 +
1.90 +See the following Web page for more information about this work:
1.91 +
1.92 +http://hgweb.boddie.org.uk/PaletteOptimiser
1.93 +
1.94 +The author can be contacted at the following e-mail address:
1.95 +
1.96 +paul@boddie.org.uk
1.97 +
1.98 +Copyright and licence information can be found in the docs directory - see
1.99 +docs/COPYING.txt and docs/gpl-3.0.txt for more information.