home *** CD-ROM | disk | FTP | other *** search
/ Freelog Special Edition 1: Linux / CD2.iso / SciTech / readme_mgl45b2.txt < prev    next >
Text File  |  1999-03-12  |  7KB  |  156 lines
  1.  
  2.                 SciTech Multi-platform Graphics Library
  3.                             Version 4.5
  4.                               BETA 2
  5.  
  6.                        Getting Started Guide
  7.  
  8.  
  9. What is this document for?
  10. --------------------------
  11.  
  12. This text document is intended to help developers get up and running
  13. with the MGL 4.5 beta products, and to show the steps necessary to
  14. compile and link the libraries and sample programs from for your
  15. OS and compiler configuration.
  16.  
  17. Installing the files
  18. --------------------
  19.  
  20. To install the files you will need a copy of the source archive, the base
  21. utilities archive for your OS and the font and bitmap resource archive.
  22. Uncompress all files in the archive into the directoy on your system
  23. where you want the files to live (normally c:\scitech or ~/scitech). The
  24. names of the archives you will need are the following:
  25.  
  26.  mgl45b2-src.zip      - Source archive in ZIP format
  27.  mgl45b2-font.zip     - Font and bitmap archive in ZIP format
  28.  mgl45b2-dos.zip      - DOS hosted base utilities
  29.  mgl45b2-os2.zip      - OS/2 hostsed base utilities
  30.  
  31.  mgl45b2-src.tar.gz   - Source archive in gzip'ed tar format
  32.  mgl45b2-font.tar.gz  - Font and bitmap archive in gzip'ed tar format
  33.  mgl45b2-linux.tar.gz - Linux hosted base utilities
  34.  mgl45b2-qnx.tar.gz   - QNX hosted base utilities
  35.  
  36. Makefile utilities configuration
  37. --------------------------------
  38.  
  39. Once you have installed the files, you need to configure the makefile
  40. utilties and tools to allow you to compile the libraries. If you are
  41. compiling under DOS a Windows DOS box, you will need to set the environment
  42. for your DOS box to at least 2048 bytes as we use a lot of environment
  43. variables.
  44.  
  45.     DOS/Windows hosted tools
  46.     ------------------------
  47.  
  48.     The first thing you need to do is edit the bin\set-vars.bat batch
  49.     file to reference the location where you have installed the files,
  50.     and the locations where all your compilers are installed. See the
  51.     comments in set-vars.bat for more information.
  52.  
  53.     Once you have the startup file configured, you then need to run the
  54.     following each time you start a command shell to enable the SciTech
  55.     makefile utilities (a good idea to put into your startup batch files):
  56.  
  57.         call c:\scitech\bin\set-vars.bat
  58.         call c:\scitech\bin\wc11-d32.bat
  59.  
  60.     The second batch file sets up the compiler configuration for your
  61.     default compiler. The line above sets up for Watcom C++ 11.0 32-bit
  62.     DOS compilation. Substitute this for any of the batch files in the
  63.     bin directory for the compiler you are using.
  64.  
  65.     OS/2 hosted tools
  66.     ------------------
  67.  
  68.     The first thing you need to do is edit the bin-os2\set-vars.cmd
  69.     script file to reference the location where you have installed the
  70.     files, and the locations where all your compilers are installed. See
  71.     the comments in set-vars.cmd for more information.
  72.  
  73.     Once you have the startup file configured, you then need to run the
  74.     following each time you start a command shell to enable the SciTech
  75.     makefile utilities (a good idea to put into your startup batch files):
  76.  
  77.         call c:\scitech\bin-os2\set-vars.cmd
  78.         call c:\scitech\bin-os2\wc11-o32.cmd
  79.  
  80.     The second batch file sets up the compiler configuration for your
  81.     default compiler. The line above sets up for Watcom C++ 11.0 32-bit
  82.     OS/2 compilation. Substitute this for any of the batch files in the
  83.     bin directory for the compiler you are using.
  84.  
  85.     Linux hosted tools
  86.     ------------------
  87.  
  88.     The first thing you need to do is edit the bin\set-vars-linux.sh
  89.     script file to reference the location where you have installed the
  90.     files, and the locations where all your compilers are installed. See
  91.     the comments in set-vars-linux.sh for more information.
  92.  
  93.     Once you have the startup file configured, you then need to run the
  94.     following each time you start a command shell to enable the SciTech
  95.     makefile utilities (a good idea to put into your startup scripts):
  96.  
  97.         ~/scitech/bin/set-vars-linux.sh
  98.         ~/scitech/bin/gcc-linux.sh
  99.  
  100.     The second script file sets up the compiler configuration for your
  101.     default compiler. The line above sets up for GNU C/C++ for Linux
  102.     (eventually other compilers will come to Linux, such a MetroWerks).
  103.  
  104.     QNX hosted tools
  105.     ----------------
  106.  
  107.     The first thing you need to do is edit the bin\set-vars-qnx.sh
  108.     script file to reference the location where you have installed the
  109.     files, and the locations where all your compilers are installed. See
  110.     the comments in set-vars-qnx.sh for more information.
  111.  
  112.     Once you have the startup file configured, you then need to run the
  113.     following each time you start a command shell to enable the SciTech
  114.     makefile utilities (a good idea to put into your startup scripts):
  115.  
  116.         ~/scitech/bin/set-vars-qnx.sh
  117.         ~/scitech/bin/qnx4.sh
  118.  
  119.     The second script file sets up the compiler configuration for your
  120.     default compiler. The line above sets up for Watcom C++ 10.6 for QNX.
  121.  
  122.     NOTE: For QNX development you will need to set the USE_BIOS=1 environment
  123.           variable to enable support for calling the BIOS. You will also need
  124.           to copy the vbios.lib files from the drivers/qnx directory into your
  125.           runtime library directories. The final release will allow you to
  126.           build MGL programs without requiring the BIOS support, but for
  127.           the moment the BIOS support is required to run under QNX, even
  128.           though it is not used if you are running on SciTech Nucleus drivers.
  129.  
  130. Compiling the libraries
  131. -----------------------
  132.  
  133. Once you have all the startup scripts configured and executed, you are
  134. ready to begin compiling. Building all the MGL libraries in one fell
  135. swoop is very easy. Simple change into the src directory below where you
  136. have installed all the files and issue a dmake build. Ie:
  137.  
  138.  cd scitech/src
  139.  dmake build
  140.  
  141. Using 'dmake build' will force build all the libraries. If any errors are
  142. encountered during the build, it will stop and you can fix the errors and
  143. then restart the build from the offending library with a simple 'dmake'
  144. (ie: the default target builds for the selected compiler). You can also
  145. build each library from each directory if you wish as well.
  146.  
  147. Compile the sample programs
  148. ---------------------------
  149.  
  150. Once you have all the libraries built, you can try to compile some of the
  151. sample programs. To build the example programs, go into the
  152. scitech/examples/mgl/samples directory and run dmake to build all the
  153. example programs.
  154.  
  155. ---- END OF README.TXT ----
  156.