Updated READMEs for 2.3.0

[fw/sdcc] / doc / README.txt

diff --git a/doc/README.txt b/doc/README.txt
index 5484aeb73641f694225e4b2951b9e1c9a57518f6..0a7b8416dfb27d66c72595cffec24e28ccab50e0 100644 (file)
--- a/doc/README.txt
+++ b/doc/README.txt
@@ -1,6 +1,75 @@
-SDCC README
------------
+SDCC - a Freeware, retargettable, optimizing ANSI-C compiler
+------------------------------------------------------------
 $Id$
 
-Links:
-* http://sdcc.sourceforge.net/
+Welcome to SDCC, a freeware, retargettable, optimizing ANSI C compiler
+that supports a growing list of processors including the Intel mcs51
+family, the Zilog Z80, and the ds390.
+
+See share/doc/sdcc/INSTALL.txt for the installation instructions for
+the binary kits.
+
+See the share/doc/sdcc 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 avr, and pic ports are currently experimental.
+
+
+Roadmap:
+COPYING                - GPL v2
+as/            - Assembler, derrived from asxxxx
+debugger/
+device/                - Device libraries and examples
+doc/           - sdcc and port specific documentation
+link/          - Linker, also derrived from asxxxx
+sim/           - Simulator (mcs51 only)
+src/           - Source to the C compiler and ports
+support/       - Libraries and apps that may not be provided by your system.
+
+
+Authors and interested persons:
+* Sandeep Dutta (sandeep@users.sourceforge.net)
+
+* Daniel Drotos     <drdani@mazsola.iit.uni-miskolc.hu>
+* Jean Loius-VERN   <jlvern@writeme.com>
+* Johan Knol        <johan.knol@iduna.nl>
+* Karl Bongers      <karl@turbobit.com>
+* Kevin Vigor       <kevin@vigor.nu>
+* Michael Hope      <michaelh@juju.net.nz> <nz_michaelh@yahoo.com>
+* Scott Dattalo     <scott@dattalo.com> 
+
+
+SDCC includes code from:
+* Alan Baldwin      <baldwin@shop-pdp.kent.edu>
+   Initial version of ASXXXX and  ASLINK. 
+* John Hartman      <jhartman@compuserve.com>
+   Porting ASXXX and ASLINK for 8051.
+* Dmitry S. Obukhov <dso@usa.net>
+   malloc and serial I/O routines.
+* Pascal Felber
+   Some of the Z80 related files are borrowed from the Gameboy
+   Development Kit (GBDK).
+