home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / utilities / gadoc.lha / gadoc.c / readme < prev   
Encoding:
Text File  |  1995-03-02  |  1.6 KB  |  73 lines
  1. GAdoc
  2. -----
  3.  
  4. This program extracts the autodocs from your source codes and generates
  5. a texinfo file out of it.
  6.  
  7. What makes this program different from ``autodoc'' [(c) Commodore] is
  8. that it generates a texinfo file.
  9. This has several advantages:
  10.  
  11.     Easy to generate a hypertext out of it (makeinfo)
  12.  
  13.     Easy to generate a .dvi file (Using TeX)
  14.  
  15.     Easy to generate plain ASCII text (makeinfo)
  16.  
  17. GAdoc is very easy to use, just open a shell and enter the following
  18.  
  19.  
  20.     gadoc <source> <dest> [options]
  21.  
  22. This will extract the autodocs from <source> and generate two new files
  23. <dest>.menu and <dest>.data, where <dest>.menu is the main part.
  24.  
  25.  
  26. Options:
  27.  
  28.          -i:     Also extract internal documentation
  29.          -c:     Convert \* to /* and *\ to */
  30.          -amiga: Include amiga support for texinfo
  31.  
  32.  
  33. Please read the documentation for further details.
  34.  
  35. This program was inspired by Robodoc 0.92:
  36.  
  37.  
  38. ROBODoc v0.92 is written by Jacco van Weert.
  39.  
  40.     Email:    weertj@euronet.nl
  41.  
  42.     or
  43.  
  44.     Maverick Software Development, T.a.v. J.v.Weert
  45.     Haverdreef 131,
  46.     7006 LH, Doetinchem.
  47.     The Netherlands.
  48.  
  49.  
  50.                 __  __________
  51.              __/  \/         /   weertj@euronet.nl
  52.           __/  \__/ Maverick
  53.          /  \__/  \ Software
  54.          \__/  \__/ Development
  55.          _______________/        slothoub@xs4all.nl
  56.  
  57.  
  58. Well, Robodoc didn't work very well with my CLisp source files, so I wrote a
  59. new one.
  60.  
  61.  
  62. GADOC and NON-AMIGA systems
  63. ---------------------------
  64.  
  65. The .info files contain the icon informtion for the amiga workbench
  66. (graphical user interface). You may delete them, BUT NOT IF YOU WANT TO
  67. RE-DISTRIBUTE gadoc!
  68.  
  69.  
  70.  
  71.  
  72. Gerhard Leibrock, Feb 1995
  73.