home *** CD-ROM | disk | FTP | other *** search
/ The Datafile PD-CD 3 / PDCD_3.iso / utilities / utilsm / mkdrawf / !!ReadMe
Text File  |  1995-04-30  |  5KB  |  154 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.  
  37.     Source.Makefile
  38.       is, erm, a makefile. You may need to change some of the definitions
  39.       at the start.
  40.  
  41. Doc
  42. ---
  43.  
  44.   contains documentation.
  45.  
  46.     Doc.ManualI
  47.     Doc.ManualT
  48.     Doc.ManualP      <-- not actually included!, but I can send it to you
  49.       contain basically the same material, except that some illustrative
  50.       drawfiles aren’t in ManualT. In order these are in Impression format,
  51.       plain text and PostScript.
  52.       Incidentally, if you try to print out ManualI on a laser printer
  53.       you are likely to have trouble, because many can’t cope with the
  54.       length of the path in the snowflake curve example. I can tell you
  55.       how to get round this.
  56.  
  57.     Doc.TutorialI
  58.     Doc.TutorialT
  59.     Doc.TutorialP    <-- like ManualP, nonexistent
  60.       contain a fairly gentle introduction to the use of mkdrawf and
  61.       decdrawf. If you find the manual heavy going, you might like to
  62.       try this.
  63.  
  64.     Doc.DrawfI
  65.     Doc.DrawfT
  66.     Doc.DrawfP       <-- guess what?
  67.       contain documentation for !Drawf, a Wimp front end for mkdrawf and
  68.       decdrawf. This is short, and it won’t take you long to read it.
  69.  
  70.     Doc.Custom
  71.       tells you a bit about how to proceed if you want to make changes
  72.       to mkdrawf.
  73.  
  74. Examples
  75. --------
  76.  
  77.   contains the mkdrawf source for the examples in the manual, and also
  78.   some drawfiles to decode with decdrawf to see the sort of output it
  79.   produces. There are also several more example source-code files.
  80.  
  81.     Examples.src
  82.       is mkdrawf source code.
  83.  
  84.     Examples.draw
  85.       is for drawfiles.
  86.  
  87.     Examples.dec
  88.       is a good place to put decoded drawfiles. I suggest here rather than
  89.       .src, so that if you decode something you created with mkdrawf you
  90.       don’t overwrite the original source.
  91.  
  92.     Examples.Makefile
  93.       is a makefile, to save you a bit of typing.
  94.  
  95. Goodies
  96. -------
  97.  
  98.   contains a couple of programs that produce mkdrawf code. You could
  99.   implement these completely in mkdrawf, but (1) it’s nicer in a better
  100.   programming language, and (2) I wrote them before mkdrawf had any
  101.   programming features.
  102.  
  103.   It also contains a useful program to compute the intersection of two
  104.   lines. Of course this really could be done in mkdrawf code, and that
  105.   might be a better way in most cases, but...
  106.  
  107.   Goodies.c.dodec
  108.   Goodies.c.icos
  109.     produce, respectively, a dodecahedron and an icosahedron. Each
  110.     should be called with 3 command-line arguments, which are rotation
  111.     angles in degrees. Experiment!
  112.   Goodies.c.intersect
  113.     takes 8 numbers (4 pairs of coordinates) and computes the intersection
  114.     of two lines. The args should be given in the order
  115.       line-1-point-1-x line-1-point-1-y line-1-point-2-x line-1-point-2-y
  116.       line-2-point-1-x line-2-point-1-y line-2-point-2-x line-2-point-2-y .
  117.  
  118.   Goodies.o
  119.     is an empty directory to put object files in if you recompile these.
  120.  
  121.   Goodies.dodec
  122.   Goodies.icos
  123.   Goodies.intersect
  124.     are the executables produced from the above, in case you don’t have
  125.     a C compiler.
  126.  
  127. !Drawf
  128. ------
  129.  
  130.   is a Wimp front end for mkdrawf and decdrawf. You can just double-click
  131.   on the icon to run the program. Inside...
  132.  
  133.   !Drawf.Source.c
  134.     contains the C source code for !Drawf.
  135.  
  136.   !Drawf.Source.o
  137.     contains `o.glib', a small library which contains some rather low-level
  138.     functions for interacting with the Wimp. (Most are basically just SWI
  139.     veneers.) If you want the source code for this, ask me.
  140.  
  141.   !Drawf.Source.h
  142.     contains header files for the stuff in o.glib.
  143.  
  144.   !Drawf.Source.Makefile
  145.     is a makefile. Amazing. You won't be able to use it to re-make
  146.     o.glib, because you don't have the source code.
  147.  
  148.   !Drawf.Run
  149.   !Drawf.!RunImage
  150.   !Drawf.!Sprites
  151.   !Drawf.Sprites
  152.   !Drawf.Templates
  153.     are just what you think they are.
  154.