home *** CD-ROM | disk | FTP | other *** search
/ Point Programming 1 / PPROG1.ISO / c / snippets / snippets.txt < prev    next >
Encoding:
Text File  |  1995-03-17  |  3.2 KB  |  68 lines
  1. INFORMATION ABOUT SNIPPETS APR 94 EDITION
  2. =========================================
  3.  
  4. Beginning with the Dec '92 edition, SNIPPETS has been distributed in two
  5. forms.
  6.  
  7. The first, and most familiar, is the full SNIPPETS collection. As before it
  8. is named "SNIPdddd.xxx", where "dddd" is the release date and "xxx" is the
  9. archive utility extension. For example, I distribute the Mar '95 edition as
  10. SNIP9503.LZH, using the LHA.EXE archive utility.
  11.  
  12. New to the Dec '92 release was SNIPDIFF, an archive containing both files and
  13. a utility to create a complete and fully-validated SNIPPETS archive using
  14. files from the last edition of SNIPPETS which haven't changed. This
  15. represents a considerable saving in the size of the archive and,
  16. consequently, the time required to download it from bulletin boards and
  17. public information services.
  18.  
  19. Beginning the Apr '93 release, SNIPDIFF became even smaller with the
  20. inclusion of DSAPP.EXE which allows that only the differences for changed
  21. files need be included. DSAPP.EXE is a public domain utility for applying
  22. changes, written by David Burton, and which is distributed with his excellent
  23. TLIB version control system.
  24.  
  25.  
  26. PORTABILITY
  27. ===========
  28.  
  29. All SNIPPETS code is tested with PC compilers from Microsoft, Borland,
  30. Watcom, and Symantec/Zortech, unless otherwise noted. Where possible, code is
  31. also tested under one or more of HP/UX, SCO Unix, or AIX, using appropriate
  32. vendor or FSF compilers.
  33.  
  34.  
  35. COMPILING SNIPPETS CODE
  36. =======================
  37.  
  38. SNIPPETS files fall into 5 categories:
  39.  
  40. 1. Archive information files. These provide information on SNIPPETS itself.
  41.    You're reading one of these right now. The most important of the
  42.    information files is SNIPPETS.NDX which contains a descriptive list of the
  43.    "real" SNIPPETS files. You should at least browse all of the information
  44.    files, grouped conveniently at the beginning of the archive.
  45.  
  46. 2. Macros and true code snippets. These will not compile to anything
  47.    meaningful by themselves. Macros are designed to be included in file
  48.    headers, while code snippets are incomplete pieces of code used to
  49.    demonstrate a general principle. Most SNIPPETS macros appear near the
  50.    beginning of the archive in .H files. True snippets are rare, but should
  51.    be obvious when you run across one.
  52.  
  53. 3. Functions. Most of the SNIPPETS files are functions. Many SNIPPETS
  54.    functions also have test code built-in which will allow them to be
  55.    compiled to stand-alone versions by defining the macro TEST during the
  56.    compilation process. Individual functions appear in the archive
  57.    immediately following the macros. SNIPPETS also contains larger, multi-
  58.    file function packages, noted by sections in SNIPPETS.NDX.
  59.  
  60. 4. Stand-alone utilities. SNIPPETS utilities are grouped at the end of the
  61.    archive in a section noted in SNIPPETS.NDX. Many utilities contain useful
  62.    functions and demonstrate useful C programming techniques.
  63.  
  64. 5. Educational files. Between the individual functions and the function
  65.    packages comprising two or more files, there is a short section of text
  66.    files answering frequently-asked questions or providing tutorials on
  67.    various aspects of C programming.
  68.