home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #6 / amigamamagazinepolishissue1998.iso / packery / xpk_source / aboutsources next >
Text File  |  1996-10-19  |  3KB  |  67 lines
  1.                        A small guide to the sources
  2.  
  3. You should begin your tour to these sources in the examples directory, which
  4. contains some simple examples of how to write applications using xpk.
  5.  
  6. The directory Shell contains the sources of what I think are the basic shell
  7. utilities for xpk.
  8.  
  9. If you want to write a sublibrary in C, the best place to start with are
  10. the sources of xpkRLEN.library or xpkENCO.library.
  11.  
  12. Assembler programmers should take a look at the sources of xpkFAST.library.
  13. I tried to separate the .library bureaucrazy from the other stuff and
  14. generally tried to write elegant and readable code while writing FAST.
  15.  
  16. People with a hang to monolitic assembler sources or a distaste for linkers
  17. will be pleased by what they'll find in the directory with the sources of
  18. xpkIDEA.library.
  19.  
  20. xpkmaster contains the cleanedup sources of the xpkmaster.library, but still
  21. is a mess.  Do not try to understand the inner workings of xpkmaster.library
  22. without first having read all the documentation.
  23.  
  24. For those, who want to write their own sublibrary:
  25. --------------------------------------------------
  26.  
  27. How has the version string to look?
  28. --> see how the standard or the example libraries handle this:
  29.  
  30. xpk<name of library> <version>.<revision> (<date>) <comments>\r\n\0
  31.  
  32. example: "xpkFAST 1.7 (07.09.96)\r\n\0"
  33.  
  34. (NOTE: \r = 0x13; \n = 0x10)
  35.  
  36. You do not need to add a "$VER: " somewhere in the text and the library
  37. name should be without ".library"! Also the date-format should be the above
  38. form, because Commodore defined this form as an nearly standard. Please
  39. make the work and include an correct library header, because this makes
  40. updating a lot easier! This means also a correct initialisation of the
  41. corresponding fields in the Resident (RomTag) structure. An example library
  42. header handling this you find in the xpk_Develop archive in the ASM-include
  43. directory. (If you have problems in doing this, contact me! - Dirk Stöcker)
  44.  
  45. How to compile the libraries with SAS-C:
  46. ----------------------------------------
  47.  
  48. Note: If Sas-C's assembler reports some errors in the asm-files take an
  49. other assembler.
  50.  
  51.   xpkmaster.library:
  52.     run an assembler with libdata.a and get the object-file libdata.o
  53.     run sc without options in the directory of the library
  54.     copy the library to LIBS:
  55.   other libraries:
  56.     run the assembler over the needed asm-file to get either the library or
  57.     an object file for the C-Compiler
  58.     if there is a SCOPTIONS file:
  59.       run sc without options in the directory of the library
  60.     copy the library to LIBS:
  61.  
  62. How to compile the libraries with Maxon C++ V3:
  63.  
  64.   use the makefile with Maxon's Make.
  65.  
  66.                         Dirk and Christian.
  67.