Updated READMEs for 2.3.0
[fw/sdcc] / doc / README.txt
1 SDCC - a Freeware, retargettable, optimizing ANSI-C compiler
2 ------------------------------------------------------------
3 $Id$
4
5 Welcome to SDCC, a freeware, retargettable, optimizing ANSI C compiler
6 that supports a growing list of processors including the Intel mcs51
7 family, the Zilog Z80, and the ds390.
8
9 See share/doc/sdcc/INSTALL.txt for the installation instructions for
10 the binary kits.
11
12 See the share/doc/sdcc directory for more documentation.
13
14 See http://sdcc.sourceforge.net/ for the latest information on sdcc.
15
16
17 License:
18 SDCC is licensed under the GNU Public license (GPL) v2.  Note that
19 this license covers the code to the compiler and other executables,
20 but explicitly does not cover any code or objects generated by sdcc.
21 We have not yet decided on a license for the run time libraries, but
22 it will not put any requirements on code linked against it. See:
23
24  http://www.gnu.org/copyleft/gpl.html
25
26
27 Support:
28 SDCC is a collaborative effort between a group of volunteers.  Please
29 feel free to report bugs via the Sourceforge bug tracker, or to ask
30 questions on the user mailing list.  See:
31
32  http://sourceforge.net/tracker/?atid=100599&group_id=599&func=browse
33
34  http://sourceforge.net/mail/?group_id=599
35
36
37 Notes:
38 * The avr, and pic ports are currently experimental.
39
40
41 Roadmap:
42 COPYING         - GPL v2
43 as/             - Assembler, derrived from asxxxx
44 debugger/
45 device/         - Device libraries and examples
46 doc/            - sdcc and port specific documentation
47 link/           - Linker, also derrived from asxxxx
48 sim/            - Simulator (mcs51 only)
49 src/            - Source to the C compiler and ports
50 support/        - Libraries and apps that may not be provided by your system.
51
52
53 Authors and interested persons:
54 * Sandeep Dutta (sandeep@users.sourceforge.net)
55
56 * Daniel Drotos     <drdani@mazsola.iit.uni-miskolc.hu>
57 * Jean Loius-VERN   <jlvern@writeme.com>
58 * Johan Knol        <johan.knol@iduna.nl>
59 * Karl Bongers      <karl@turbobit.com>
60 * Kevin Vigor       <kevin@vigor.nu>
61 * Michael Hope      <michaelh@juju.net.nz> <nz_michaelh@yahoo.com>
62 * Scott Dattalo     <scott@dattalo.com> 
63
64
65 SDCC includes code from:
66 * Alan Baldwin      <baldwin@shop-pdp.kent.edu>
67    Initial version of ASXXXX and  ASLINK. 
68 * John Hartman      <jhartman@compuserve.com>
69    Porting ASXXX and ASLINK for 8051.
70 * Dmitry S. Obukhov <dso@usa.net>
71    malloc and serial I/O routines.
72 * Pascal Felber
73    Some of the Z80 related files are borrowed from the Gameboy
74    Development Kit (GBDK).
75