mcs/class/PEAPI/README.txt

   1 PEAPI\r
   2 -----\r
   3 \r
   4 This is a preliminary version of our PE writer component.  It is a managed \r
   5 component which presents on the client side an API and constructs program \r
   6 executable files.  \r
   7 \r
   8 We have tested this component as an alternative backend for Gardens Point \r
   9 Component Pascal .NET.  Our previous versions of gpcp produced textual CIL and\r
  10 invoked ilasm.  The new backend can create a program executable file in almost\r
  11 exactly the same length of time as it takes to write the equivalent CIL text \r
  12 file.  \r
  13 \r
  14 PEAPI is written in C# and is released as open source under a FreeBSD-like \r
  15 licence.  Included in this release is pdf documentation and both html and \r
  16 chm documentation.  The main documentation is written as if it was a new \r
  17 Appendix to John Gough's book Compiling for the .NET Common Language Runtime, \r
  18 Prentice-Hall 2002.\r
  19 \r
  20 The current release implements most of the facilities of the API however, \r
  21 some final features not required for component pascal have yet to be added.  \r
  22 We expect to update the component incrementally as additional features are \r
  23 added.  Currently the component does not produce debugger information (pdb \r
  24 files).  We are considering possible ways of doing this or alternatively \r
  25 producing rotor-format debugging information.\r
  26 \r
  27 The team has a committment to maintain and update the component into the \r
  28 foreseeable future, as several other projects here depend on it.  Users are \r
  29 encouraged to send feedback on missing features, bug reports etc. to assist \r
  30 in this quest.\r
  31 \r