home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / pmos2002.zip / README < prev    next >
Text File  |  1996-09-03  |  8KB  |  188 lines
  1.         README file for the PMOS/2 library (Last updated 1996/09/03)
  2.         ==================================
  3.  
  4. Welcome to PMOS/2.  PMOS/2 is a set of Modula-2 modules designed
  5. to be used in conjunction with the OS/2 operating system.  It is,
  6. in fact, an OS/2 port of the PMOS library, which is a programmer's
  7. library for writing multitasking software either under DOS or in
  8. embedded systems where there is no operating system.  Because of
  9. the major differences in the underlying systems, PMOS/2 is not
  10. quite the same as PMOS, but I've tried to keep the two consistent
  11. to a reasonably high degree.
  12.  
  13. Subject to certain conditions which are described below, this
  14. software is free.
  15.  
  16. There is, at this stage, no proper documentation for PMOS/2.
  17. You might find the PMOS documentation useful; it's in a report called
  18. the "PMOS Reference Manual", which can be found at most places
  19. where PMOS is available.  The most definitive documentation,
  20. however, is in the source files themselves.  In particular, you
  21. should check out the contents of the .DEF files.
  22.  
  23.  
  24. DISCLAIMER
  25.  
  26. Like all free software, this package is supplied "as is", and no
  27. warranties are made or implied as to its fitness for any particular
  28. purpose.  The author does not accept responsibility for any damage,
  29. including consequential damage, caused by the use of this software,
  30. except to the extent to which this disclaimer may be overridden by law.
  31.  
  32.  
  33. LICENCE INFORMATION
  34.  
  35. All of the components of the PMOS/2 package may freely be
  36. used subject to the following conditions.  If you do not accept the
  37. conditions, do not use the package.  Your use of any part of PMOS/2
  38. implies your acceptance of these conditions.
  39.  
  40. 1. Neither PMOS/2 nor any derived product may be sold or distributed
  41.    for a fee, or used to enhance the value of a product for which a
  42.    fee is charged, except by prior agreement.  The author is willing
  43.    to negotiate agreements with individuals or companies for commercial
  44.    use of PMOS/2, but in the absence of such an agreement PMOS/2 is
  45.    for non-profit use only.
  46.  
  47.    [Note to shareware authors and others involved in low-profit
  48.    ventures: under certain circumstances I am willing to grant a
  49.    fee-free licence for the commercial use of PMOS/2.  As a general
  50.    rule I will charge a fee only for substantial commercial use or
  51.    when you are in competition with a company in which I hold an
  52.    interest; and I will not charge a fee for small-scale use or for
  53.    educational use.  Nevertheless the present licence covers only
  54.    non-profit use of PMOS/2, and any other use must be separately
  55.    negotiated.]
  56.  
  57.    The present licence permits the use of PMOS/2 for evaluation purposes
  58.    or for the building of prototypes which are not for sale.
  59.  
  60. 2. You may give copies of PMOS/2 to other people, and keep copies in
  61.    software repositories such as anonymous ftp servers, but only if this
  62.    README file is included.
  63.  
  64. 3. You may modify PMOS/2, but only if you agree that the altered
  65.    version continues to be subject to the conditions given here.
  66.    The name of the original author(s), and any copyright notices
  67.    contained in these files, may not be deleted in the course of
  68.    making such alterations.
  69.  
  70.  
  71. PREREQUISITES
  72.  
  73. Hardware: Sufficient to run OS/2.
  74.  
  75. Operating system: This software has been developed using OS/2 Warp,
  76.     and has also been tested on Warp Connect.  It will probably work
  77.     on earlier or later versions of OS/2, but has not been tested
  78.     with those other versions.
  79.  
  80. Compiler: The software has been developed using XDS Modula-2 (OS/2
  81.     Native Code version).  Since XDS is generally compatible with
  82.     the Modula-2 standard, the source code should be portable to
  83.     other ISO-compliant compilers with little effort.  Note, however,
  84.     that different compilers could have different ways of providing
  85.     an interface to the OS/2 system functions.  PMOS/2 has quite
  86.     a few operating system dependencies, so you might find yourself
  87.     having to modify code wherever something is imported from OS2.DEF.
  88.  
  89.  
  90. INSTALLATION
  91.  
  92. If you have read this far, then you've probably already completed
  93. the installation.  But, just in case something went wrong, here's
  94. what you should have done:
  95.  
  96. 1. Create a directory, e.g. D:\PMOS2, to hold all of the PMOS/2
  97.    files.  (You could use an existing directory, but I advise against
  98.    it; it gets confusing if two or more software packages live in the
  99.    same directory.)
  100.  
  101. 2. Unzip the distribution file into this directory.  If you're using
  102.    InfoZip, appropriate subdirectories are created automatically.
  103.    If you're using PKUnzip, make sure to use the -d option to
  104.    ensure that the subdirectory structure is preserved.
  105.  
  106.  
  107. DE-INSTALLATION
  108.  
  109. If you don't want to keep PMOS/2, simply delete the directory you
  110. created during installation, and all of its contents.
  111. PMOS/2 does not alter your INI files or your CONFIG.SYS, it
  112. doesn't tamper with your PATH, and it does not scatter its files
  113. through your system directories.
  114.  
  115. (Now, if only we could talk all software providers into following
  116. those rules.)
  117.  
  118.  
  119. WHAT'S IN THE DIRECTORIES
  120.  
  121. After you have installed PMOS, you will have the following directories.
  122.  
  123.       PMOS2
  124.           Files needed for installation.
  125.  
  126.       PMOS2\DEF
  127.           Modula-2 definition modules.
  128.  
  129.       PMOS2\DOC
  130.           Some documentation files.  You should read through these
  131.           at some stage.
  132.  
  133.       PMOS2\SRC
  134.           The main directory for PMOS/2 source files.  This is where
  135.           you will find almost all of the PMOS/2 source code.
  136.  
  137.       PMOS2\SRC\ANSI
  138.           Modules that use ANSI.SYS for text-mode screen output.  For now, this
  139.           is the only kind of screen output we support.  (But there are plans to add
  140.           better screen output modules later.)
  141.  
  142.       PMOS2\TESTS
  143.           Project files for making some test programs.
  144.  
  145.       PMOS2\TESTS\SRC
  146.           Source code for the test programs.
  147.  
  148.       PMOS2\UTIL
  149.           Project files for making some utility programs.
  150.  
  151.       PMOS2\UTIL\DEF and PMOS2\UTIL\SRC
  152.           Source code for the utility programs.
  153.  
  154. Depending on which version you picked up, you might find some other
  155. subdirectories: object modules, new modules which are not yet working, etc.
  156.  
  157. [NOTE: The current version of PMOS/2 is a very early release.
  158. Most of PMOS has not yet been ported to PMOS/2.  You'll have to
  159. wait until after a few more releases to get a more substantial
  160. software collection.]
  161.  
  162. It is strongly recommended that you not put any of your own files
  163. into any of these directories.  Mixing up your own work with the PMOS/2
  164. files is potentially very confusing.  The preferred method is to make
  165. a new top-level directory for your own work, and to use the PMOS2
  166. directory and its subdirectories exclusively for the PMOS/2 components.
  167.  
  168. If you have both PMOS and PMOS/2, don't put them in the same directory.
  169. That would certainly create conflicts.
  170.  
  171.  
  172. CONTACT INFORMATION
  173.  
  174. The author of PMOS/2 is
  175.  
  176.             Peter Moylan
  177.             Department of Electrical and Computer Engineering
  178.             The University of Newcastle, NSW 2308
  179.             Australia.
  180.  
  181.             Phone: +61 49 21 6023      (time zone GMT+10)
  182.             Fax:   +61 49 21 6993
  183.             e-mail:   peter@ee.newcastle.edu.au
  184.             WWW:  http://www.ee.newcastle.edu.au/users/staff/peter/Moylan.html
  185.  
  186. The preferred method of contacting me is via e-mail; this will probably
  187. bring a faster response than with paper mail.
  188.