home *** CD-ROM | disk | FTP | other *** search
/ Enigma Amiga Life 106 / EnigmaAmiga106CD.iso / software / utilities / xpk_source / aboutsources
Encoding:
Text File  |  1998-11-09  |  4.3 KB  |  100 lines
  1. IMPORTANT: As long as any of the authors are reachable via mail/e-mail
  2. contact them first, before you make somehow changed/patched versions.
  3.  
  4. Also the sources of xpkmaster.library are offered, but this doesn't give
  5. you the right to create your own version of xpkmaster.library (it is not
  6. public domain software). Everytime you have to contact either Dirk Stöcker,
  7. Christian von Roques or Urban Dominik Müller. We may give you the OK to
  8. do further development!
  9.  
  10. ----------------------------------------------------------------------------
  11.  
  12. You should begin your tour to these sources in the examples directory, which
  13. contains some simple examples of how to write applications using XPK.
  14.  
  15. The directory Shell contains the sources of what I think are the basic shell
  16. utilities for XPK. These utilites are a bit outdated, as they are written
  17. for use under OS1.3 (except xBench and xPack).
  18.  
  19. The directory test contains some test programs (in C) which were needed
  20. during development of some features. These files may be most useful for you.
  21. Four of these programs (FindFileType, PrintFileTypes, StripXpkStuff,
  22. testXpkPrefsSem) use undocumented features (mentioned in source code) and
  23. thus should never be used in distributed programs. That's why the test
  24. utilities are not distributed as binaries! All the others are correct
  25. style and may be used as examples how to use xpkmaster. NOTE: as these are
  26. test utilities they miss most of necessary error reporting functions,
  27. which should be in an distributed tool.
  28.  
  29. If you want to write a sublibrary in C, the best place to start with are
  30. the sources of xpkNONE.library and xpkNUKE.library.
  31.  
  32. Assembler programmers should take a look at the sources of xpkFAST.library.
  33. Christian separated the library bureaucrazy from the other stuff and
  34. generally tried to write elegant and readable code while writing FAST.
  35.  
  36. People with a hang to monolitic assembler sources or a distaste for linkers
  37. will be pleased by what they'll find in the directory with the sources of
  38. xpkHUFF.library.
  39.  
  40. The SDI includes are replacements of standard ANSI functions. These includes
  41. mostly reduce the size of the executable, but they are not fully compatible
  42. to the ANSI C ones. You may use them or replace the include line with
  43. <stdlib>, <stdio.h> and <string.h>.
  44. The SDI defines define things I often use (f.e. CTRL_C and the version
  45. string).
  46.  
  47. xpkmaster contains the cleanedup sources of the xpkmaster.library. Do not
  48. try to understand the inner workings of xpkmaster.library without first
  49. having read all the documentation. Do not think after reading the docs you
  50. understand them. (It took me a half year to really understand some parts. :-)
  51.  
  52. For those, who want to code their own sublibrary:
  53. --------------------------------------------------
  54.  
  55. How has the version string to be like?
  56. --> see how the standard or the example libraries handle this:
  57.  
  58. xpk<name of library> <version>.<revision> (<date>) <comments>\r\n\0
  59.  
  60. example: "xpkFAST 1.7 (07.09.96)\r\n\0" (NOTE: \r = 0x13; \n = 0x10)
  61.  
  62. You do not need to add a "$VER: " somewhere in the text and the library
  63. name should be without ".library"! Also the date format should be the above
  64. form, because Commodore defined this form as an nearly standard. Please
  65. make the work and include a correct library header, because this makes
  66. updating a lot easier! This means also a correct initialisation of the
  67. corresponding fields in the Resident (RomTag) structure. You find an
  68. example library header handling this in the xpk_Develop archive in the
  69. ASM-include directory. If you have problems in doing this, contact me!
  70.  
  71. How to compile the asm only stuff:
  72. ----------------------------------
  73.  
  74. Run your assembler over the master file (mostly xpk____.a) and you get the
  75. final output file.
  76.  
  77. How to compile with SAS-C:
  78. --------------------------
  79.  
  80. Call smake in the directory. You may have to change the assembler line
  81. to your assembler before doing this!. I use everytime PhxAss assembler,
  82. because it seems to be powerful and it is freely distributable.
  83.  
  84. How to compile with Maxon's compiler:
  85. -------------------------------------
  86.  
  87. xpkmaster.library:
  88.  (C++ V3) Use the MakeFile with Maxon's Make
  89.  (DEV V4) Compile library using xpkmaster.project.
  90.  
  91. other programs and libraries:
  92.  Use assembler to get object files of asm-sources.
  93.  Compile C files (mostly large data mode!) and link together with .o files
  94.  made with assembler.
  95.  
  96. Dirk Stöcker <stoecker@amigaworld.com>
  97.  
  98. 26th October 1998
  99.  
  100.