home *** CD-ROM | disk | FTP | other *** search
/ Doom Extras / DExtras.iso / accessor / dos / deu521 / source / readme < prev    next >
Text File  |  1994-05-20  |  7KB  |  164 lines
  1. SOURCE.ZIP README FILE
  2. ======================
  3. This zip file (SOURCE.ZIP) contains the source files for DEU 5.2.
  4.  
  5. Please note that DEU 5.2 has been ported to GCC.  The sources for
  6. the GCC version (which compiles under Borland C too, but have some
  7. differences) are available in the SOURCE.ZIP file contained in the
  8. DEU52GCC package.
  9.  
  10. The average DEU user will not need these source files.  But if you
  11. want to work on the code and contribute to the DEU effort, or just
  12. want to have a look at the files and see how some things are done,
  13. then please read this file.
  14.  
  15.  
  16. How do I compile DEU?
  17. =====================
  18.  
  19. This program has been developped with Turbo C and Borland C++.  You
  20. should be able to compile it with Turbo C 3.0, Borland C++ 3.1, 4.0
  21. or higher.
  22.  
  23. If you are working with the IDE or the command-line compiler, the
  24. only important thing is to choose the Huge memory model.  You are
  25. free to choose the other options, such as optimize for speed/optimize
  26. for size, allow overlays, use a 387 or an emulation, etc.
  27.  
  28. The executable in the standard DEU distribution has been compiled
  29. with support for 387 emulation, for greater compatibility.  If you
  30. re-compile the code using direct 387 code, the program will be 30-40%
  31. faster in some cases.
  32.  
  33.  
  34. Conditional #defines
  35. ====================
  36.  
  37. The code includes some #ifdef's that may be used to change the
  38. behaviour of the program.  Here are the symbols that may be defined,
  39. and what they do.
  40.  
  41. * NO_CIRCLES
  42.  
  43.   There is a bug in the standard EGAVGA.BGI drivers: it doesn't
  44.   support XOR mode when drawing circles.  Some other drivers may
  45.   have this kind of problems too.  If you want to use one of these
  46.   buggy drivers but don't want to see lots of garbage on your screen
  47.   when you use the Ruler cursor ('R'), then define this symbol and
  48.   DEU will draw squares instead of circles.
  49.  
  50. * CIRRUS_PATCH
  51.  
  52.   A patch has been added to the 5.2 code.  This patch is only useful
  53.   for those who have a Cirrus Logic VGA card.  If you use the '-cc'
  54.   command line option, it will use a hardware cursor for the mouse,
  55.   instead of the ugly "fake cursor" ('-fc').  But even if the
  56.   hardware cursor is not activated when you don't use the '-cc'
  57.   option, the code will still be there.  The standard DEU executable
  58.   has been compiled with this symbol defined, but you may want to
  59.   compile DEU without defining it, if you are having some problems
  60.   with your mouse (or if you want to make the executable smaller).
  61.  
  62. * DEBUG
  63.  
  64.   At various times, different parts of the code have been/will be
  65.   enclosed between "#ifdef DEBUG"/"#endif" statements.  Define this
  66.   symbol at your own risks...
  67.  
  68.  
  69. Contributions to the code
  70. =========================
  71.  
  72. Since DEU is a Public Domain program, you are free to do whatever you
  73. want with it.  But please read README.1ST if you want to know what is
  74. considered polite...
  75.  
  76. If you changed some parts of the DEU code (to fix a problem, add a
  77. new feature, or turn it into something completely different), you may
  78. want to make your patch available to other people.
  79.  
  80. There are two ways to do that:
  81.  
  82. * Distribute the new version of the program under a new name.  You
  83.   should only do that if you (re-)wrote a significant part of the
  84.   code.  You should give credit to the original DEU (see README.1ST).
  85.   But you should also use a different name that won't throw people
  86.   into confusion: please don't name it DEUA, DEUX, MyDEU or anything
  87.   close.  The name of your editor should be sufficiently different.
  88.  
  89. * Send the patch to us, so that it will be included in the next
  90.   release of DEU.  This is the best way to contribute: all DEU users
  91.   will benefit from your code.  And if you want to really work on the
  92.   code, you can join our young and dynamic development team. :-)
  93.   Of course, your name will be added to the 'Credits' list, along
  94.   with a few lines that describe what great things you did for DEU...
  95.  
  96.  
  97. Adding new features to DEU
  98. ==========================
  99.  
  100. If you want to work on some part of the code and send your
  101. contribution to us, you should first take a look at the 'Future
  102. Plans' section in README.1ST.  If some things are listed there, then
  103. there is probably already someone working on it.  The best thing to
  104. do if you want to work on one of these projects is to get in touch
  105. with us as soon as possible, so that we all work together instead of
  106. having several people working independently (which is a waste of
  107. time).
  108.  
  109. You should also take a look at the COMMENTS file.  It contains some
  110. comments about the routines in DEU, and also a TO-DO list.  You might
  111. find some interesting things there.  But once again, if something is
  112. in the TO-DO list, there is probably someone working on it.  You'd
  113. better get in touch with Brendon and Raphael first.
  114.  
  115. Well, let's suppose that you have added some marvellous new feature
  116. to DEU and you want to send it to us...  Here are a few important
  117. things that you should bear in mind:
  118.  
  119. * DEU is Public Domain, and all contributions must be in the Public
  120.   Domain too.  That means: no copyrights.  We cannot and will not
  121.   accept copyrighted contributions.  You will have your name in the
  122.   credits (and you can also add a line in the header of the source
  123.   file(s) if you added a new module to DEU), but please don't put a
  124.   copyright on what you did.
  125.  
  126. * If your new feature takes several pages of code, it's better to
  127.   put everything in a single new file that will be linked with DEU.
  128.   Just tell us what should be added in DEU.H and when (and how) your
  129.   new function(s) should be called.
  130.  
  131. * If your routine is a patch for one or more existing source files,
  132.   the best way to send it is to use the UNIX-style "context diff".
  133.   The 'diff' and 'patch' programs are also available for DOS and
  134.   OS/2, so please use them if you can.  Note: use a "context diff"
  135.   ("diff -c file1 file2"), not a normal diff, because the 'patch'
  136.   program will fail if there are too many differences in the file to
  137.   be patched and only a "normal diff" is available.
  138.  
  139. * Make sure that your code has been fully tested.  Also, try to use
  140.   the same programming style (name of variables, indentation,
  141.   spacing between variables and operators, comments, etc.) because
  142.   we don't want to have to do all these changes by hand.
  143.  
  144.  
  145. General comments for the code
  146. =============================
  147.  
  148. We have tried to keep the code as clean as possible.  Every routine
  149. should have at least a one-line comment that describes what it does,
  150. and a few comments inside it to describe obscure parts of the code.
  151.  
  152. Please try to do the same thing in your own code.  The source files
  153. will look better if they have the same "style" everywhere.  And if
  154. you have the time, add some comments for the declarations too (types
  155. and variables).
  156.  
  157. A source file wiithout comments is hard to read, but it can also be
  158. hard to read if there are too many comments.  Try to keep a good
  159. balance.  If you want to add lots of comments about how your code
  160. works, please add them in the COMMENTS file, but not in the source
  161. files.
  162.  
  163. Thanks in advance!
  164.