home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / PROG_GEN / FACETV.ZIP / README.1ST < prev    next >
Text File  |  1993-11-18  |  4KB  |  137 lines
  1. @(#) README.1ST        11/18/93    Chris Ahlstrom
  2.  
  3.  
  4.  
  5.  
  6.     OVERVIEW OF INSTALLATION AND USAGE OF THE FACE_TV LIBRARY
  7.  
  8.  
  9. 0.  Scope of document
  10.  
  11.     This document just gets you started quickly on installing
  12. and "make'ing" the FACE_TV library.  It mostly just points to the
  13. documents you need to use.
  14.  
  15.  
  16. 1.  Making Directories
  17.  
  18.     You've probably already extracted all the files into the
  19. directory you've decided to use.  But here's what I intended, though
  20. I haven't yet made it into a self-extracting, self-starting
  21. executable.
  22.  
  23.     First, you need to decide where you want to locate the
  24. following sets of files.  I show first the directory names I use,
  25. just to make recognition quicker, perhaps.
  26.  
  27.     Don't run INSTALL.BAT until you read this; otherwise, it
  28. will make things that maybe you don't want.
  29.  
  30.  
  31.     C:\USR\LIB    Location of *all* header files and library
  32.             files for all home-grown packages, such as
  33.             my FACE, FACE_TV, and QUIKKI libraries.  The
  34.             INSTALL.BAT file included with FACE_TV will
  35.             attempt to create a directory for this
  36.             purpose.
  37.  
  38.             In any case, the FACE_TV makefile requires
  39.             the code to located in the specified place.
  40.             You can edit your AUTOEXEC.BAT, INSTALL.BAT,
  41.             and even the FACE_TV makefile, to change this
  42.             to your preference.
  43.  
  44.     C:\BC        Main directory for the Borland C compiler.
  45.             You probably already have this set up and
  46.             ready to go.
  47.             
  48.             INSTALL.BAT assumes it exists already.
  49.  
  50.  
  51.     C:\CA\C\FACE\TV    Location for the source code for the FACE_TV
  52.             library.
  53.  
  54.             INSTALL.BAT will *not* create this directory.
  55.             Make it yourself, and tell INSTALL.BAT about
  56.             it.
  57.  
  58.             My convention is to have a directory for all
  59.             of my (CA's) stuff, with a C code directory,
  60.             which includes one directory for each
  61.             project.
  62.  
  63.  
  64. 2.  Environment variables
  65.  
  66.     You'll have to read the makefile anyway, to see what environment
  67. variables it requires.  Here's a summary:
  68.  
  69.  
  70.    Makefile      Directories used on
  71.    Variable      Chris's machine (edit them)
  72.  
  73.     BCL        = $(COMPILE)\BC\LIB
  74.     TVL        = $(COMPILE)\BC\TVISION\LIB
  75.     BGI        = $(COMPILE)\BC\BGI
  76.     USR        = $(COMPILE)\USR\LIB
  77.     INCLUDEPATH    = $(COMPILE)\BC\INCLUDE;$(COMPILE)\BC\TVISION\INCLUDE
  78.  
  79.  
  80.     Note that you'll have to set %COMPILE% in your own AUTOEXEC.BAT.
  81.  
  82.  
  83. 3.  Loading the source code
  84.  
  85.     Anyway, you can make all the directories and environment
  86. variables as above, if needed, and then read INSTALL.BAT.  If it
  87. does what you want, execute it.  It will extract the source code
  88. from the diskette into the directories of your choice.
  89.  
  90.     In addition, it will also make the object modules, the file
  91. FACE_TV.LIB, and a sample executable, FACE_TV.EXE.
  92.  
  93.     It will also copy the header files and FACE_TV.LIB to the
  94. specified user-directory.
  95.  
  96.     Otherwise, you will have to copy the FACE_TV.ZIP file to
  97. your source code area, and extract it yourself with the command
  98.  
  99.     PKKUNZIP FACE_TV
  100.  
  101.  
  102. 3.  Making the source code
  103.  
  104.     If you decided to do all this by hand (probably a wise move),
  105. then, given that your environment is setup as described in the
  106. makefile, all you need to do is type
  107.  
  108.     MAKE
  109.  
  110. You might want to edit the makefile to conform to your compiler
  111. situation.
  112.  
  113.  
  114. 4.  Storing the library
  115.  
  116.     Be sure to move the FACE_TV.LIB and *.H files to the
  117. local USR directory of your choice.
  118.  
  119.  
  120. 5.  Using the library
  121.  
  122.     The makefile shows how to use the library to build a
  123. nice test program.
  124.  
  125.     The program also serves as a teaching aid, as the
  126. documentation outside of the source code [and even in the source
  127. code <grin>] is rather rudimentary.
  128.  
  129.  
  130. 6.  Summary of things to read
  131.  
  132.     1.  INSTALL.BAT
  133.     2.  MAKEFILE
  134.     3.  The source code
  135.     4.  DIALOGS.TXT (probably very incomplete)
  136.     5.  FILELIST.TXT
  137.