home *** CD-ROM | disk | FTP | other *** search
/ The Unsorted BBS Collection / thegreatunsorted.tar / thegreatunsorted / programming / misc_programming / install.me < prev    next >
Text File  |  1994-08-23  |  9KB  |  196 lines
  1.  
  2.         SciTech Software Distribution - Standard Directory Structure
  3.         ------------------------------------------------------------
  4.  
  5. This file describes the general directory structure of the SciTech Software
  6. programming libraries that you have installed. This directory structure
  7. is common to all SciTech Software products.
  8.  
  9. Find a nice home for it all
  10. ---------------------------
  11.  
  12. Before you install any of SciTech Software Products, you should decide upon
  13. a standard root directory for installing all of the products into. The
  14. default that we use is under the \SCITECH directory of one of our hard drives
  15. (in my case C:). Then you should install all the files for all the
  16. distributions that you have under the same directory tree. Many of the
  17. products use common libraries to get things done (like the PMODE library)
  18. and common header files. When you install them into the same directory
  19. you will only have one copy of each of these common files.
  20.  
  21. IMPORTANT: Once you decided on a root directory for installing your SciTech
  22.            Software Products, you should install them all into the same
  23.            directory. The command to do this with PKZIP would be (assuming
  24.            that all products are installed under C:\SCITECH):
  25.  
  26.                 pkunzip -d <zipfile>.zip C:\SCITECH
  27.  
  28.            This will correctly unzip all the archived files and create the
  29.            correct directory structure under the root directory C:\SCITECH
  30.  
  31.            Note that the '-d' command line option is essential to ensure
  32.            that the correct directory structure is built.
  33.  
  34. Installing for use
  35. ------------------
  36.  
  37. Once you have created the directory structure for the distribution, and
  38. all files have been installed, you will need to perform two final steps
  39. before you can use the libraries:
  40.  
  41.     1. Change your compilers default include path to include the
  42.        d:\SCITECH\INCLUDE directory so your compiler can find the required
  43.        include files, where d: is the drive that you have installed the
  44.        software onto.
  45.  
  46.     2. Change your compilers default library path to include the
  47.        d:\SCITECH\LIB\??? directory (substitute the correct sub-directory
  48.        name for your compiler - d:\SCITECH\LIB\BC3 is for Borland C++ 3.1).
  49.  
  50. Once you have done this, you can simply start using the library files as
  51. provided. If you intend to re-compile any of the libraries from the
  52. provided source code, you will need to follow the steps in the next
  53. section.
  54.  
  55. SciTech Software Common Makefile Utilities
  56. ------------------------------------------
  57.  
  58. In order to be able to re-compile any of the SciTech Software Distributions
  59. that come with source code, you will also need to install the SciTech
  60. Software Common Makefile Utilities package. This can be found in the
  61. archive called MKUTIL??.ZIP from the same location that you obtained this
  62. package from. This archive contains all of the relevant executable files
  63. (including a copy of DMAKE 3.8), batch files and DMAKE startup files
  64. required to re-compiled the source code for any of the supported compilers.
  65.  
  66. Once you have installed the files onto your hard drive, you will need to
  67. perform the following steps:
  68.  
  69.     1. Change the default executable file path in your AUTOEXEC.BAT file
  70.        to include the d:\SCITECH\BIN directory. This should be placed
  71.        at the START of your path, so that the MAKE.EXE file in the BIN
  72.        directory will be found first, rather than your compilers usual
  73.        make utility.
  74.  
  75.     2. Set the environment variables SCITECH and MGL_ROOT (if you are using
  76.        the MegaGraph Graphics Library). The batch file MGL_ENV.BAT in
  77.        the root \SCITECH directory is a sample of this. The SCITECH
  78.        environment variable is used by the batch files in the BIN
  79.        directory for setting up for compiling with a particular compiler,
  80.        and by the DMAKE program so that it can find all of the relevant
  81.        files during compilation.
  82.  
  83.     3. Set up the enivornment variables needed by the bacth files in the
  84.        next step, so that they can located your compilers executable files,
  85.        include files and library files. The file BIN\SET-VARS.BAT is an
  86.        example that we use, so you can start with this to build you own
  87.        batch file.
  88.  
  89.     4. Run the relevant batch file to set the environment up for your
  90.        compiler. The will file begin with a two letter prefix, and
  91.        end in either 16-VAR.BAT or 32-VAR.BAT (depending on whether you will
  92.        be compiling for 16 or 32 modes). These files require the SCITECH
  93.        environment variable to setup correctly, and the relevant variables
  94.        from the previous step to be set up correctly.
  95.  
  96. The following compilers are usually supported by SciTech Software, along with
  97. the code used by the batch files from step 4 above (some libraries may not
  98. support a particular compiled depending on lanuage requirements):
  99.  
  100.     bc3     - Borland C++ 3.1 16 bit
  101.     bc16    - Borland C++ 4.0 16 bit
  102.     bc32    - Borland C++ 4.0 32 bit
  103.     vc16    - Microsoft Visual C++ 1.
  104.     vc32    - Microsoft Visual C++ 1.
  105.     sc16    - Symantec C++ 6.1 16 bit
  106.     sc32    - Symantec C++ 6.1 32 bit
  107.     wc16    - Watcom C++ 10.0 16 bit
  108.     wc32    - Watcom C++ 10.0 32 bit
  109.     hc32    - Metaware High C/C++ 3.2
  110.     dj32    - DJGPP GNU C/C++ 32 bit
  111.  
  112. Once you have everything set up correctly, you should simply be able to
  113. type MAKE in any of the source directories and be in business.
  114.  
  115. Compiling with Optimisations or for Debugging
  116. ---------------------------------------------
  117.  
  118. By default when you build the libraries, not optmisations and no debugging
  119. information is generated. You can turn either (or both) of these features
  120. on by setting the OPT or DBG variables for DMAKE. You can do this either
  121. by passing them on the command line, or setting them as environment
  122. variables:
  123.  
  124.     make OPT=1 DBG=1
  125.  
  126. or
  127.  
  128. set OPT=1
  129. set DBG=1
  130. make
  131.  
  132. Changing the default DOS Extender
  133. ---------------------------------
  134.  
  135. All of the SciTech Software libraries are DOS Extender independant. All
  136. DOS extender dependant information is encapsulated in the PMODE.LIB library.
  137. The default library provided for each of the compilers is compiled for
  138. the default DOS extender normally used by that compiler. All you need to
  139. do in order to use a different DOS extender is re-compile the PMODE
  140. library with the appropriate command line options, and then link with
  141. this new library. Refer to the documentation on the PMODE library for
  142. more details.
  143.  
  144. All SciTech Software distributions that require the PMODE library, come
  145. with a pre-compiled version of the library for the default DOS extender
  146. used by that compiler. If you wish to change the DOS extender, or you
  147. wish to have a look at the source code, you will need to obtain the
  148. PMODE library source archive. You should be able to get this from the
  149. same site that you downloaded this archive from as the file PMLITE??.ZIP.
  150.  
  151. Directory tree
  152. --------------
  153.  
  154. The following is a brief outline of the directory tree, and the contents of
  155. all the sub-directories (note that not all of these will be present in
  156. every SciTech Software Distribution archive):
  157.  
  158. SCITECH             ROOT directory (SCITECH is default official name)
  159. │
  160. ├───BIN             Useful tools and batch files for library building
  161. │
  162. ├───DOC             Documentation files. Each individual product has its own
  163. │                   separate directory which contains all files specific to
  164. │                   that product.
  165. │
  166. ├───FONTS           All MGL font files installed here.
  167. │
  168. ├───BITMAPS         All MGL bitmap files installed here.
  169. │
  170. ├───CURSORS         All MGL mouse cursor files installed here.
  171. │
  172. ├───ICONS           All MGL icon files installed here.
  173. │
  174. ├───EXAMPLES        Any example source code. Separate sub-directories are
  175. │                   provided for each of the different products.
  176. │
  177. ├───MANIFEST        List of all files installed for each Distribution
  178. │
  179. ├───INCLUDE         All installed header files.
  180. │
  181. ├───LIB             All installed library files. Separate sub-directories are
  182. │   ├───BC16        provided for each of the different supported compilers.
  183. │   ├───...         These directories contain the pre-compiled versions of
  184. │   └───WC32        the library files ready for use.
  185. │
  186. ├───LIBSW           All installed shareware library files. In the shareware
  187. │   ├───BC16        distributions these directories contain pre-compiled
  188. │   ├───...         shareware versions of the library files ready for use.
  189. │   └───WC32
  190. │
  191. └───SRC             All source code for building the libraries (if provided).
  192.     ├───PMODE       Each package has a separate directory that contains all
  193.     ├───...         of the source code and makefiles for building the library
  194.     └───SVGAKIT     and installing it under \SCITECH\LIB.
  195.  
  196.