home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / snip9707.zip / SNIPPETS.TXT < prev    next >
Text File  |  1997-07-05  |  7KB  |  166 lines
  1. +++Date last modified: 05-Jul-1997
  2.  
  3. INFORMATION ABOUT SNIPPETS Jul 97 EDITION
  4. =========================================
  5.  
  6. See WHATS.NEW for specific information on changes and additions to SNIPPETS.
  7.  
  8. Beginning with the Dec '92 edition, SNIPPETS has been distributed in two
  9. forms.
  10.  
  11. The first, and most familiar, is the full SNIPPETS collection. As before it
  12. is named "SNIPdddd.xxx", where "dddd" is the release date and "xxx" is the
  13. archive utility extension. For example, I distribute the Mar '95 edition as
  14. SNIP9503.LZH, using the LHA.EXE archive utility.
  15.  
  16. New to the Dec '92 release was SNIPDIFF, an archive containing both files and
  17. a utility to create a complete and fully-validated SNIPPETS archive using
  18. files from the last edition of SNIPPETS which haven't changed. This
  19. represents a considerable saving in the size of the archive and,
  20. consequently, the time required to download it from bulletin boards and
  21. public information services.
  22.  
  23. Beginning the Apr '93 release, SNIPDIFF became even smaller with the
  24. inclusion of DSAPP.EXE which allows that only the differences for changed
  25. files need be included. DSAPP.EXE is a public domain utility for applying
  26. changes, written by David Burton, and which is distributed with his excellent
  27. TLIB version control system.
  28.  
  29. For those using 4DOS or other shell programs which use DESCRIPT.ION files,
  30. this release includes the source to a new utility, To4Dos.C, which processes
  31. the SNIPPETS.NDX file into a description file. To use it, simply compile it
  32. and run it in the same directory with the SNIPPETS files. It will read
  33. SNIPPETS.NDX and generate DESCRIPT.ION automatically.
  34.  
  35.  
  36. PORTABILITY
  37. ===========
  38.  
  39. All SNIPPETS code is tested with PC compilers from Microsoft, Borland,
  40. Watcom, and Symantec/Zortech, unless otherwise noted. Where possible, code is
  41. also tested under one or more of HP/UX, SCO Unix, or AIX, using appropriate
  42. vendor or FSF compilers. Beginning with this release, the SNIPPETS.NDX file
  43. lists portability for each file. This information is for general guidance
  44. only. For example, the code to implement the Bresenham line and circle
  45. drawing algorithms is portable, but the implementation using PC graphics is
  46. not. Code listed as portable to "any" OS, should be portable, possibly with
  47. minor changes. Code listed as being specific for a particular OS usually
  48. contains references to system dependencies that makes it useless in other
  49. environments.
  50.  
  51. Note that, just as it's impossible to assure compatibility with unsupported
  52. compilers, it's equally impossible to assure portability with every version
  53. of every supported compiler. Some older compilers from the vendors mentioned
  54. here may not work with all SNIPPETS code. During the testing of this release,
  55. I had help from many kind people working with different tools in different
  56. environments, but you may still have some problems - and especially if you're
  57. using an older compiler that's more than 1 or 2 revisions out of date.
  58.  
  59.  
  60. COMPILING SNIPPETS CODE
  61. =======================
  62.  
  63. SNIPPETS files fall into 5 categories:
  64.  
  65. 1. Archive information files. These provide information on SNIPPETS itself.
  66.    You're reading one of these right now. The most important of the
  67.    information files is SNIPPETS.NDX which contains a descriptive list of the
  68.    "real" SNIPPETS files. You should at least browse all of the information
  69.    files, grouped conveniently at the beginning of the archive.
  70.  
  71. 2. Macros and true code snippets. These will not compile to anything
  72.    meaningful by themselves. Macros are designed to be included in file
  73.    headers, while code snippets are incomplete pieces of code used to
  74.    demonstrate a general principle. Most SNIPPETS macros appear near the
  75.    beginning of the archive in .H files. True snippets are rare, but should
  76.    be obvious when you run across one.
  77.  
  78. 3. Functions. Most of the SNIPPETS files are functions. Many SNIPPETS
  79.    functions also have test code built-in which will allow them to be
  80.    compiled to stand-alone versions by defining the macro TEST during the
  81.    compilation process. Individual functions appear in the archive
  82.    immediately following the macros. SNIPPETS also contains larger, multi-
  83.    file function packages, noted by sections in SNIPPETS.NDX.
  84.  
  85. 4. Stand-alone utilities. SNIPPETS utilities are grouped at the end of the
  86.    archive in a section noted in SNIPPETS.NDX. Many utilities contain useful
  87.    functions and demonstrate useful C programming techniques.
  88.  
  89. 5. Educational files. Between the individual functions and the function
  90.    packages comprising two or more files, there is a short section of text
  91.    files answering frequently-asked questions or providing tutorials on
  92.    various aspects of C programming.
  93.  
  94.  
  95. DISTRIBUTION
  96. ============
  97.  
  98. Starting with the December 1992 version, SNIPPETS is distributed in two
  99. files:
  100.  
  101. SNIPdddd.xxx is the full SNIPPETS collection.
  102. SNPDdddd.xxx contains only the files changes since the last release.
  103.  
  104. Note that "dddd" above is the date code. SNIPPETS archives released prior to
  105. 1994 encoded the date as mmyy, where "mm" is a 2-digit month code and "yy" is
  106. a 2-digit year code. Beginning with the April, 1994 release, the date code
  107. has been changed to yymm (following the same conventions), to facilitate
  108. directory sorting.
  109.  
  110. Note that "xxx" above is the archiver extension. As distributed, these
  111. include:
  112.  
  113.       .ZIP - Compatible with PKzip ver. 2.04+ and/or Info-Zip 1.9+
  114.       .LZH - Compatible with LHA ver. 2.1+
  115.       .TAZ - Unix .tar.Z compatible
  116.       .RAR - Compatible with RAR ver. 1.5+
  117.  
  118. SNIPPETS is distributed through the FidoNet Programmer's Distribution Network
  119. and via the Internet.
  120.  
  121. FidoNet locations to get SNIPPETS (for FidoNet file requests, the magic names
  122. "SNIPPETS" and "SNIPDIFF" may he used to obtain the latest versions from many
  123. BBS's):
  124.  
  125.         1:106/2000 - my "home" BBS, Comm Port One, (713) 980-9671
  126.         1:2320/38  - home of FidoNet Programmer's Distribution Network (PDN)
  127.         1:11/70
  128.         Other PDN sites
  129.  
  130. Internet locations to get SNIPPETS via anonymous ftp:
  131.  
  132.         snippets.org          /pub/snippets
  133.           (This is the official SNIPPETS ftp distribution site)
  134.         juge.com              /file/c
  135.         connectn.acs.niu.edu  ~/C
  136.         ftp.funet.fi          /pub/msdos/Simtel/c (Europe)
  137.         ftp.microdot.com.au   /pub/snippets (Australia)
  138.         ftp.simtel.net        /pub/simtelnet/msdos/c (also Simtel CD-ROM)
  139.  
  140. World-Wide Web sites
  141.  
  142.         http://www.snippets.org
  143.           (This is the official SNIPPETS web site home page)
  144.         http://www.strangecreations.com/strange/library/snippets.htm
  145.         http://src.doc.ic.ac.uk/packages/simtel-msdos/c/ (Europe)
  146.  
  147. Places that may also have SNIPPETS:
  148.  
  149.         Bix                   page 1445 in the programming RT
  150.         Compuserve
  151.         GEnie
  152.         America Online
  153.         numerous BBS's around the world
  154.  
  155. -------------------------------  Enjoy!  -----------------------------------
  156.  
  157.  
  158. Bob Stout
  159. FidoNet:    1:106/2000.6
  160.             C_Echo moderator (1990-1991, 1996-1997)
  161. Internet:   rbs@snippets.org
  162.             rbs@brokersys.com
  163. SnailMail:  MicroFirm
  164.             P.O. Box 428
  165.             Alief, TX 77411
  166.