home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 22 gnu / 22-gnu.zip / db02_src.zip / README < prev    next >
Text File  |  1993-11-05  |  4KB  |  89 lines
  1. DiamondBase README
  2.  
  3. This file contains a short list of instructions on installing DiamondBase.
  4.  
  5. Please make sure you have read the Copyright file.
  6.  
  7. The first thing you need to do, is unpack the distribution. Well, you seem
  8. to have achieved that so we'll skip to the next bit...
  9.  
  10. If you have GNU Make then you should use the 'Makefile' in this directory.
  11. If not, there is a quick and dirty Makefile.gen which works with standard
  12. make. 
  13.  
  14. If you have GNU Make, edit the Makefile and modify the OS = line on the
  15. first page of it. If your operating system is not listed, see below. You
  16. may also want to change the BINDIR and LIBDIR to point to where you want to
  17. install DiamondBase. These changes can also be done by setting environment
  18. variables.
  19.  
  20. If your OS is not listed and is not similar enough to the ones there so
  21. that compilation works, then define your own OS by adding the appropriate
  22. section to the Makefile. There are instructions in the Makefile for what
  23. all the symbols mean. Please do not modify the existing systems unless you
  24. find an error. Rather add a new section and send the changes to us (see
  25. BUGS below).
  26.  
  27. If you are using Makefile.gen, you will probably want to change all the
  28. defines in there. They have the same meaning as the ones in Makefile. You
  29. don't need to inform us if you change this file.
  30.  
  31. Once you have fixed up the Makefile, all you need to do is enter 'make' (or
  32. 'make -f Makefile.gen' if you're not using GNU Make).
  33.  
  34. This will compile the diamondBase library and the Schema compiler, dsc. You
  35. may install these with 'make install' (make -f Makefile.gen install)
  36.  
  37. This will copy the library into LIBDIR and dsc into BINDIR. You are now
  38. ready to use DiamondBase. Read the documentation for instructions on how to
  39. use it.
  40.  
  41.  
  42. MULTIUSER VERSION
  43.  
  44. The multiuser version can be compiled by using: make multi
  45. It can be installed with: make installmulti
  46.  
  47. DOCUMENTATION
  48.  
  49. There is a very nice (we think) manual for the package in LaTeX format in
  50. this distribution. To make the documentation enter 'latex doc.tex'. When
  51. this finishes, run it a second time to get the page/figure references
  52. accurate. This will produce doc.dvi. You can either preview this or convert
  53. it to some printable form (eg, by using dvips).
  54.  
  55. If you do not have LaTeX, then we can send you the dvi file.
  56. If you do not have dvi tools, we can send you a PostScript version.
  57. If you do not have PostScript, we can send you an ascii version.
  58. If you do not have ascii... Well, er, um, things are looking bad for you.
  59.  
  60. Then you're ready to use DiamondBase. Good Luck.
  61.  
  62. BUGS
  63.  
  64. What are they? Hopefully you won't find any, but if you do, please mail a
  65. desription of the bug and maybe even a bit of code to exploit it along with
  66. any patches you might have that fix the bug to the following address:
  67.  
  68.     darrenp@dibbler.cs.monash.edu.au
  69.  
  70. We will attempt to rectify the bug or incorporate your patches. We would
  71. also like to hear about errors in the manual.
  72.  
  73. NOTE: Please include a description of the platform you are running
  74. DiamondBase on including the architecture, compiler and any other relevant
  75. info. Please also include and changes you have made to the Makefile,
  76. particularly compiler flags. Also compile and run the version program and
  77. send us the output of that with your bug.
  78.  
  79. DiamondBase was written by, and is maintained by:
  80.  
  81. Darren Platt: darrenp@dibbler.cs.monash.edu.au
  82. Andrew Davison: davison@bruce.cs.monash.edu.au
  83. Kevin Lentin: kevinl@bruce.cs.monash.edu.au
  84.  
  85. We invite comments on the package, suggestions etc.
  86.  
  87. Note. Some of the things we mention are trademarks of some big companies
  88. with lots of lawyers.
  89.