
PICKLE Development Kit

This archive contains various documents and pieces of source code,
which can be used to play with PICKLE files. There are two basic
libraries here: the reader library, which is what an interpreter 
needs to load data from PICKLE files, and the editor library, which
contains additional functions useful for analyzing and creating
PICKLE files.

You should first read the beginning of reader-library-doc.txt,
which explains how to adjust pickle.h for your own machine. (This
probably just means picking big-endian or little-endian.) Then
you can type "make all" to build piklist and pikmake.

Try "piklist test.pik" to list the contents of test.pik.
Try "pikmake test.dir newtest.pik" to create a new PICKLE file
    called newtest.pik, using the data listed in test.dir.

Contents of this archive:

pickle-spec.txt: PICKLE specification
reader-library-doc.txt: Documentation for the reader library
utility-doc.txt: Documentation for piklist and pikmake
zip-support.txt: Instructions for adding PICKLE support to generic 
    ZIP (using the reader library)
pickle.c, pickle.h: Source code for the reader library
picklewr.c, picklewr.h: Source code for the editor library
piklist.c: Source for a program to list the contents of PICKLE files
    (uses the editor library)
pikmake.c: Source for a program to create PICKLE files (uses the
    editor library)
test.pik: A sample PICKLE file.
test.dir: A sample directory file, used by pikmake to create PICKLE 
    files. This one was used to create test.pik. 
test.z5, test1.pic, test2.pic, test3.pic: The components of 
    test.pik. Look at test.dir to see how they're put together.


Please note that the three test?.pic files are text files (they
become pict/text chunks) which are formatted Unix-style, with
newlines (ctrl-J, '\012') between lines. This is the way they should
be, even if you're building PICKLE files on a Mac and IBM. (See the
spec.) If you're on an IBM and your archive tool has mangled these
files to newline+return format, you'll have to unmangle them.

Other files (documentation, Makefile, and test.dir) should be
whatever format is most comfortable for your editor and your ANSI
library. If you got the Unix archive on Unix, or the Mac archive on
Mac, this is already correct. IBM users are on their own.

