home *** CD-ROM | disk | FTP | other *** search
/ APDL Public Domain 1 / APDL_PD1A.iso / program / c / desklib / docs / !MakeNote next >
Encoding:
Text File  |  1994-10-22  |  4.8 KB  |  113 lines
  1. Notes on compiling DeskLib
  2. ==========================
  3.  
  4. Some of the sub-libraries need to include main DeskLib .h files. They expect
  5. the System Variable DeskLib$Path to be set up with the full pathname of the
  6. main desklib directory, as in:
  7.  
  8.   Set DeskLib$Path ADFS::4.$.C_Work.DeskLib.
  9.  
  10. (The fullstop at the end is vital)
  11. This is correctly set up if the filer has 'seen' the "!DeskLib" application
  12.  
  13. This should be used in your programs as in:
  14.   #include "DeskLib:Icon.h"
  15.  
  16. When linking, you can use "DeskLib:o.DeskLib"
  17. However, !DeskLib also adds itself onto the end of C$Path, so C:o.DeskLib
  18. will suffice.
  19.  
  20. ---
  21.  
  22. In every subdirectory of desklib that can be "made", there is a makefile
  23.  
  24. This can be modified slightly to make just that section of the library as a
  25. seperate library file, if you don't need all of the desklib functions. This
  26. is done using 'libfile'. WimpSWIs already uses this to produce a secondary
  27. library file (so to use WIMP swis you either include DeskLib OR WimpLib)
  28.  
  29. To make any portion of DeskLib, use amu on the MakeFile as normal.
  30. Note that these makefiles probably don't work with !Make, but does anybody
  31. really like !Make enough to use it anyway? Use !Edit... it's easier and
  32. quicker (oh, and amu takes much!! less memory than !Make).
  33.  
  34. ---
  35.  
  36. If you do not have the Acorn assembler, then be very careful not to delete
  37. any of the precompiled .o files, as you will not be able to re-make them
  38. without the assembler. If someone can be bothered, a TLA-compatible version
  39. of assembler libraries may be made available in the future.
  40.  
  41. All C portions of the library may be supplied as source only.
  42. The final DeskLib library is also provided so you can start using it without
  43. having to spend 20 minutes (or 37 seconds for RiscPC owners ;-) compiling
  44. first!
  45.  
  46. Note that DeskLib relies on the directory structure as supplied: If you
  47. move (for example) either the !TestApp or WimpSWIs directories, then they
  48. (and other things) may fail to compile, as the source/libraries referenced
  49. by these things will not be available to the rest of the library.
  50. However, these dependencies are only caused by the layout of the makefiles,
  51. so if you wish to move stuff around, alter the MakeFiles to suit.
  52.  
  53. ---
  54.  
  55. The directory structure of DeskLib is as follows:
  56.  
  57. DeskLib
  58.  |
  59.  |________ !DeskLib   DeskLib compile-time resources
  60.  |                    This contains the header (.h) files, as well as the
  61.  |                    complete DeskLib library file. This is all that you NEED
  62.  |                    to have in an easy to reach place for compiling using
  63.  |                    DeskLib. (See its !Help for more details)
  64.  |
  65.  |________ Docs       Documentation files
  66.  |          |
  67.  |          |________ ModuleNote  Extra notes (where necessary) on various
  68.  |          |                     DeskLib code modules
  69.  |          |
  70.  |          |________ QuickRefs   Quick reference files/charts to make 
  71.  |          |                     using DeskLib code easier.
  72.  |          |
  73.  |          |________ Blanks      Blank makefiles, headers, etc.
  74.  |
  75.  |________ Examples
  76.  |          |
  77.  |          |________ !TestApp   Test/Example application for DeskLib.
  78.  |          |                    Full sources are included within.
  79.  |          |
  80.  |          |________ ?          Other examples of DeskLib usage
  81.  |                               These usually include sources
  82.  |
  83.  |________ OtherSrc   Repository for any general source files that are not
  84.  |                    included in the DeskLib library file. These are for
  85.  |                    you to cut and paste into your own code in most cases
  86.  |                    (or in the case of Error.c for you to compile in
  87.  |                    yourself as you will most likely want more control of
  88.  |                    how errors are reported)
  89.  |
  90.  |________ Libraries
  91.             |________ !MakeDLib   An obey file that MAKEs each part of 
  92.             |                     DeskLib, and then compiles the DeskLib
  93.             |                     Library
  94.             |
  95.             |________ !Objects    This is a 'via' file of all the library
  96.             |                     objects for LibFile to include into DeskLib
  97.             |                     (so don't delete it!)
  98.             |
  99.             |________ Clean       An obey file that wipes all of the .o
  100.             |                     files (except those that were assembled,
  101.             |                     as some users may not have the assembler
  102.             |                     as well as the C compiler.
  103.             |
  104.             |________ ?           Each subdirectory in here contains the
  105.                                   source and makefile for a subset of the
  106.                                   DeskLib library.
  107.  
  108. To completely make DeskLib, simply open the 'Libraries' directory and
  109. double click on the obey file !MakeDLib.
  110.  
  111. To make the Test Application, change directory into the application directory
  112. and type 'amu'.
  113.