* Makefile.in, configure.in, configure,
[fw/sdcc] / doc / README.txt
index 5484aeb73641f694225e4b2951b9e1c9a57518f6..c5a77000a9a7afdbbbe7e1be4e54fd4cdbbea577 100644 (file)
@@ -1,6 +1,90 @@
-SDCC README
------------
+SDCC - free open source, retargettable, optimizing ANSI-C compiler
+------------------------------------------------------------------
 $Id$
 
-Links:
-* http://sdcc.sourceforge.net/
+
+Welcome to SDCC, free open source, retargettable, optimizing ANSI C compiler
+that supports a growing list of processors including the Intel mcs51
+family, the Zilog z80, the Maxim ds390 and ds400, the Motorola HC08 and the
+PIC16 and PIC18 familiy.
+
+See share/sdcc/doc/INSTALL.txt for the installation instructions for
+the binary kits.
+
+See the share/sdcc/doc directory for more documentation.
+
+See http://sdcc.sourceforge.net/ for the latest information on sdcc.
+
+
+License:
+SDCC is licensed under the GNU Public license (GPL) v2.  Note that
+this license covers the code to the compiler and other executables,
+but explicitly does not cover any code or objects generated by sdcc.
+We have not yet decided on a license for the run time libraries, but
+it will not put any requirements on code linked against it. See:
+
+ http://www.gnu.org/copyleft/gpl.html
+
+
+Support:
+SDCC is a collaborative effort between a group of volunteers.  Please
+feel free to report bugs via the Sourceforge bug tracker, or to ask
+questions on the user mailing list.  See:
+
+ http://sourceforge.net/tracker/?atid=100599&group_id=599&func=browse
+
+ http://sourceforge.net/mail/?group_id=599
+
+
+Notes:
+* The ds400, pic14 and pic16 are currently experimental, but work is in
+progress. Please check http://sdcc.sourceforge.net/snap.php for snapshots.
+* The TININative, gbz80, avr and xa51 targets are no longer maintained.
+
+Roadmap:
+COPYING         - GPL v2
+as/             - Assembler, derived from asxxxx
+debugger/
+device/         - Device libraries and examples
+doc/            - sdcc and target specific documentation
+link/           - Linker, also derived from asxxxx
+sim/            - Simulator (mcs51 only)
+src/            - Source to the C compiler and targets
+support/        - Libraries and apps that may not be provided by your system.
+
+
+Authors and interested persons:
+* Sandeep Dutta (sandeep AT users.sourceforge.net)
+
+* Jean Loius-VERN      <jlvern AT writeme.com>
+* Daniel Drotos        <drdani AT mazsola.iit.uni-miskolc.hu>
+* Kevin Vigor          <kevin AT vigor.nu>
+* Johan Knol           <johan.knol AT iduna.nl>
+* Scott Dattalo        <scott AT dattalo.com>
+* Karl Bongers         <karl AT turbobit.com>
+* Bernhard Held        <bernhard AT bernhardheld.de>
+* Frieder Ferlemann    <frieder.ferlemann AT web.de>
+* Jesus Calvino-Fraga  <jesusc AT ece.ubc.ca>
+* Borut Razem          <borut.razem AT siol.net>
+* Vangelis Rokas       <vrokas AT otenet.gr>
+* Erik Petrich         <epetrich AT ivorytower.norman.ok.us>
+* Paul Stoffregen      <paul AT pjrc.com>
+* Michael Hope         <michaelh AT juju.net.nz> <nz_michaelh AT yahoo.com>
+* Maarten Brock        <sourceforge.brock AT dse.nl>
+* Raphael Neider       <RNeider AT web.de>
+* Hans-Juergen Dorn    <hans.dorn AT apl-landau.de>
+* Klaus Flittner       <klaus_flittner AT gmx.de>
+* Philipp Klaus Krause <pkk AT spth.de>
+
+SDCC includes code from:
+* Alan Baldwin      <baldwin AT shop-pdp.kent.edu>
+   Initial version of ASXXXX and  ASLINK. 
+* John Hartman      <noice AT noicedebugger.com>
+   Porting ASXXXX and ASLINK for 8051.
+* Dmitry S. Obukhov <dso AT usa.net>
+   malloc and serial I/O routines.
+* Pascal Felber
+   Some of the Z80 related files are borrowed from the Gameboy
+   Development Kit (GBDK).
+* The GCC development team http://gcc.gnu.org/
+   The basis of sdcpp preprocessor