Introduce src dir.

[librarian.git] / src / librarian / font-optimizer / ext / Font-TTF / README.TXT

diff --git a/src/librarian/font-optimizer/ext/Font-TTF/README.TXT b/src/librarian/font-optimizer/ext/Font-TTF/README.TXT
new file mode 100644 (file)
index 0000000..ad6a602
--- /dev/null
+++ b/src/librarian/font-optimizer/ext/Font-TTF/README.TXT
@@ -0,0 +1,99 @@
+        Perl Module: Font::TTF\r
+\r
+=head1 Introduction\r
+\r
+Perl module for TrueType font hacking. Supports reading, processing and\r
+writing of the following tables: GDEF, GPOS, GSUB, LTSH, OS/2, PCLT,\r
+bsln, cmap, cvt, fdsc, feat, fpgm, glyf, hdmx, head, hhea, hmtx, kern,\r
+loca, maxp, mort, name, post, prep, prop, vhea, vmtx and the reading and\r
+writing of all other table types.\r
+\r
+In short, you can do almost anything with a standard TrueType font with\r
+this module. Be Brave!\r
+\r
+Any suggestions, improvements, additions, subclasses, etc. would be gratefully\r
+received and probably included in a future release. Please send them to me.\r
+\r
+This module has been tested on Win32, Unix and Mac.\r
+\r
+Applications that were associated with this module have been moved to Font::TTF::Scripts where great things can be done.\r
+\r
+=head1 SYNOPSIS\r
+\r
+Here is the regression test (you provide your own font). Run it once and then\r
+again on the output of the first run. There should be no differences between\r
+the outputs of the two runs.\r
+\r
+    use Font::TTF::Font;\r
+\r
+    $f = Font::TTF::Font->open($ARGV[0]);\r
+\r
+    # force a read of all the tables\r
+    $f->tables_do(sub { $_[0]->read; });\r
+\r
+    # force read of all glyphs (use read_dat to use lots of memory!)\r
+    # $f->{'loca'}->glyphs_do(sub { $_[0]->read; });\r
+    $f->{'loca'}->glyphs_do(sub { $_[0]->read_dat; });\r
+    # NB. no need to $g->update since $_[0]->{'glyf'}->out will do it for us\r
+\r
+    $f->out($ARGV[1]);\r
+    $f->DESTROY;               # forces close of $in and maybe memory reclaim!\r
+\r
+=head1 Installation\r
+\r
+If you have received this package as part of an Activestate PPM style .zip file\r
+then type\r
+\r
+    ppm install Font-TTF.ppd\r
+\r
+Otherwise.\r
+\r
+To configure this module, cd to the directory that contains this README file\r
+and type the following.\r
+\r
+    perl Makefile.PL\r
+\r
+Alternatively, if you plan to install Font::TTF somewhere other than\r
+your system's perl library directory. You can type something like this:\r
+\r
+    perl Makefile.PL PREFIX=/home/me/perl INSTALLDIRS=perl\r
+\r
+Then to build you run make.\r
+\r
+    make\r
+\r
+If you have write access to the perl library directories, you may then\r
+install by typing:\r
+\r
+    make install\r
+\r
+To tidy up, type:\r
+\r
+    make realclean\r
+\r
+Win32 users should use pmake instead of make. Alternatively installation can be\r
+done on Win32 by typing:\r
+\r
+    Setup\r
+\r
+Or using the install feature in tools like WinZip.\r
+\r
+=head1 CHANGES\r
+\r
+=head2 Future Changes\r
+\r
+I do not anticipate any more restructuring changes (but reserve the right to do so).\r
+\r
+=head1 AUTHOR\r
+\r
+Martin Hosken L<Martin_Hosken@sil.org>\r
+\r
+Copyright Martin Hosken 1998 and following.\r
+\r
+No warranty or expression of effectiveness for anything, least of all anyone's\r
+safety, is implied in this software or documentation.\r
+\r
+=head2 Licensing\r
+\r
+The Perl TTF module is licensed under the Perl Artistic License.\r
+\r