readme.md: Fixed typo
[deark.git] / foreign / readme-compface.txt
blob562e17a1e76f77be06cf64fb429e9563847df27f
1 uncompface.h is derived from the Compface software by James Ashton, which reads
2 and writes the image format often called "X-Face". It has been heavily modified
3 for Deark.
5 Modifications for Deark are Copyright (C) 2017 Jason Summers.
7 Compface is distributed under a permissive license that appears to be similar
8 to the MIT license.
10 The Compface code from which uncompface.h was derived includes patches by Piete
11 Brooks and Ken Yap. However, I believe that none of the code from those patches
12 remains in uncompface.h.
14 The modifications for Deark are hereby released under the same license as the
15 main part of Deark, or the same license as Compface, at your option.
17 The version history of Compface is messy, due to the lack of consistent version
18 numbering, and the fact that the original author seems to have abandoned it
19 early on. However, my research suggests that there have been essentially no
20 changes to the important code, other than to add support for XBM format (which
21 Deark does not use). All the other changes that I've seen are related to
22 compatibility and packaging.
24 The contents of the README file from Compface 1.4 are reproduced below, in
25 their entirety.
27 ------------------------------------------------------------------------
28 Compface - 48x48x1 image compression and decompression
29 Copyright (c) James Ashton 1990.
30 Written 89/11/11
32 Feel free to distribute this source at will so long as the above
33 message and this message are included in full.
35 [I have put MIT in the License field of the LSM descriptions since this
36 seems to capture the original author's intent most closely, bearing in
37 mind that he wrote this before the various free software licenses were
38 categorised. - Ken]
40 The programme (two programmes really - but they're just links to each
41 other) converts 48x48x1 images to and from a compressed format.  The
42 uncompressed images are expected to contain 48x48/4 (576) hex digits.
43 All other characters and any `0's followed by `X' or `x' are ignored.
44 Usually the files are 48 lines of "0x%04X,0x%04X,0x%04X,".  The
45 compressed images contain some number of printable characters.  Non
46 printable characters, including ` ' are ignored.  The purpose of the
47 programme is to allow the inclusion of face images within mail headers
48 using the field name `X-face: '.
50 The programmes make use of a library which can be used to allow the
51 compression and decompression algorithms to be used in other
52 programmes such as mail despatchers and mail notification daemons.
54 A small amount of editing in the Makefile may be required to get it
55 going - mainly setting EXECUTABLE to what you want and putting the
56 manual entry in the right place.
58                                                 James Ashton.
59                                                 jaa@cs.su.oz.au
61 1999-06-18
63 I have merged the -X patch by Piete Brooks <Piete.Brooks@cl.cam.ac.uk>
64 into the sources and amended the man page. I have given this the
65 version number 1.1 so that it can be submitted to freshmeat.net and
66 metalabs.unc.edu.
68                                                 Ken Yap
69                                                 ken@acm.org
71 2000-11-22
73 Added support for strerror().  Incremented version to 1.4