home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 5 / DATAFILE_PDCD5.iso / utilities / m / makedrawf / !!ReadMe
Text File  |  1996-12-04  |  6KB  |  166 lines
  1. 1. This software (and its documentation) is copyrighted; please see the
  2.    documentation for details. (Don’t panic: it’s free...)
  3.  
  4. 2. I don’t think mkdrawf will work under RISC OS 2, because it uses
  5.    FontManager calls that didn’t exist then (for calculating text
  6.    bounding boxes). If you have RISC OS 2, you can replace the
  7.    relevant code with something more simple-minded -- copy the code
  8.    that’s used when an undeclared font is found. Of course, some of
  9.    the drawfile object types aren’t understood by RISC OS 2’s !Draw,
  10.    but that’s a different matter...
  11.    decdrawf should be completely OK with RISC OS 2.
  12.    !Drawf uses some RISC OS 3 calls, but not (I think) so essentially
  13.    that you couldn't make it work under RISC OS 2. For this you will
  14.    probably want the source for o.glib -- ask me.
  15.  
  16. 3. What follows is a brief “map” of this distribution.
  17.  
  18. ----------------------------------------------------------------------------
  19.  
  20. Source
  21. ------
  22.  
  23.   contains source code, of course.
  24.  
  25.     Source.c
  26.     Source.h
  27.     Source.o
  28.     Source.s
  29.       are just what you’d expect (.s is assembler)
  30.       and contain the complete source code, and object files for
  31.       the machine-code bits (so you don’t need an assembler).
  32.  
  33.     Source.mdkrawf
  34.     Source.decdrawf
  35.       are the actual programs (so you don’t need a compiler or assembler).
  36.       You should move them to somewhere in your Run$Path.
  37.  
  38.     Source.Makefile
  39.       is, erm, a makefile. You may need to change some of the definitions
  40.       at the start.
  41.  
  42. Doc
  43. ---
  44.  
  45.   contains documentation.
  46.  
  47.     Doc.ManualI
  48.     Doc.ManualT
  49.     Doc.ManualP      <-- not actually included!, but I can send it to you
  50.       contain basically the same material, except that some illustrative
  51.       drawfiles aren’t in ManualT. In order these are in Impression format,
  52.       plain text and PostScript.
  53.       Incidentally, if you try to print out ManualI on a laser printer
  54.       you are likely to have trouble, because many can’t cope with the
  55.       length of the path in the snowflake curve example. I can tell you
  56.       how to get round this.
  57.  
  58.     Doc.TutorialI
  59.     Doc.TutorialT
  60.     Doc.TutorialP    <-- like ManualP, nonexistent
  61.       contain a fairly gentle introduction to the use of mkdrawf and
  62.       decdrawf. If you find the manual heavy going, you might like to
  63.       try this.
  64.  
  65.     Doc.DrawfI
  66.     Doc.DrawfT
  67.     Doc.DrawfP       <-- guess what?
  68.       contain documentation for !Drawf, a Wimp front end for mkdrawf and
  69.       decdrawf. This is short, and it won’t take you long to read it.
  70.  
  71.     Doc.Changes
  72.       contains an entry for every new version since 2.20, saying what's
  73.       changed. It's more for my convenience than yours :-).
  74.  
  75.     Doc.Credits
  76.       is just what you think it is.
  77.  
  78.     Doc.Custom
  79.       tells you a bit about how to proceed if you want to make changes
  80.       to mkdrawf.
  81.  
  82. Examples
  83. --------
  84.  
  85.   contains the mkdrawf source for the examples in the manual, and also
  86.   some drawfiles to decode with decdrawf to see the sort of output it
  87.   produces. There are also several more example source-code files.
  88.  
  89.     Examples.src
  90.       is mkdrawf source code.
  91.  
  92.     Examples.draw
  93.       is for drawfiles.
  94.  
  95.     Examples.dec
  96.       is a good place to put decoded drawfiles. I suggest here rather than
  97.       .src, so that if you decode something you created with mkdrawf you
  98.       don’t overwrite the original source.
  99.  
  100.     Examples.Makefile
  101.       is a makefile, to save you a bit of typing.
  102.  
  103. Goodies
  104. -------
  105.  
  106.   contains a couple of programs that produce mkdrawf code. You could
  107.   implement these completely in mkdrawf, but (1) it’s nicer in a better
  108.   programming language, and (2) I wrote them before mkdrawf had any
  109.   programming features.
  110.  
  111.   It also contains a useful program to compute the intersection of two
  112.   lines. Of course this really could be done in mkdrawf code, and that
  113.   might be a better way in most cases, but...
  114.  
  115.   Goodies.c.dodec
  116.   Goodies.c.icos
  117.     produce, respectively, a dodecahedron and an icosahedron. Each
  118.     should be called with 3 command-line arguments, which are rotation
  119.     angles in degrees. Experiment!
  120.   Goodies.c.icosi
  121.     is an interactive version of icos, which displays its output on
  122.     the screen and allows you to change the parameters.
  123.   Goodies.c.intersect
  124.     takes 8 numbers (4 pairs of coordinates) and computes the intersection
  125.     of two lines. The args should be given in the order
  126.       line-1-point-1-x line-1-point-1-y line-1-point-2-x line-1-point-2-y
  127.       line-2-point-1-x line-2-point-1-y line-2-point-2-x line-2-point-2-y .
  128.  
  129.   Goodies.o
  130.     is an empty directory to put object files in if you recompile these.
  131.  
  132.   Goodies.dodec
  133.   Goodies.icos
  134.   Goodies.icosi
  135.   Goodies.intersect
  136.     are the executables produced from the above, in case you don’t have
  137.     a C compiler.
  138.  
  139. !Drawf
  140. ------
  141.  
  142.   is a Wimp front end for mkdrawf and decdrawf. You can just double-click
  143.   on the icon to run the program. Inside...
  144.  
  145.   !Drawf.Source.c
  146.     contains the C source code for !Drawf.
  147.  
  148.   !Drawf.Source.o
  149.     contains `o.glib', a small library which contains some rather low-level
  150.     functions for interacting with the Wimp. (Most are basically just SWI
  151.     veneers.) If you want the source code for this, ask me.
  152.  
  153.   !Drawf.Source.h
  154.     contains header files for the stuff in o.glib.
  155.  
  156.   !Drawf.Source.Makefile
  157.     is a makefile. Amazing. You won't be able to use it to re-make
  158.     o.glib, because you don't have the source code.
  159.  
  160.   !Drawf.Run
  161.   !Drawf.!RunImage
  162.   !Drawf.!Sprites
  163.   !Drawf.Sprites
  164.   !Drawf.Templates
  165.     are just what you think they are.
  166.