test macro substitution inside macro args
[tinycc.git] / README
blob359ea0586cf4139dc8ab3ddbe5c1954d4ef62173
1 Tiny C Compiler - C Scripting Everywhere - The Smallest ANSI C compiler
2 -----------------------------------------------------------------------
4 Features:
5 --------
7 - SMALL! You can compile and execute C code everywhere, for example on
8   rescue disks.
10 - FAST! tcc generates optimized x86 code. No byte code
11   overhead. Compile, assemble and link about 7 times faster than 'gcc
12   -O0'.
14 - UNLIMITED! Any C dynamic library can be used directly. TCC is
15   heading torward full ISOC99 compliance. TCC can of course compile
16   itself.
18 - SAFE! tcc includes an optional memory and bound checker. Bound
19   checked code can be mixed freely with standard code.
21 - Compile and execute C source directly. No linking or assembly
22   necessary. Full C preprocessor included. 
24 - C script supported : just add '#!/usr/local/bin/tcc -run' at the first
25   line of your C source, and execute it directly from the command
26   line.
28 Documentation:
29 -------------
31 1) Installation
33 *** TCC currently only works on Linux x86 with glibc >= 2.1 ***.
35    ./configure
36    make
37    make test
38    make install
40 By default, tcc is installed in /usr/local/bin.
41 ./configure --help  shows configuration options.
44 2) Introduction
46 We assume here that you know ANSI C. Look at the example ex1.c to know
47 what the programs look like.
49 The include file <tcclib.h> can be used if you want a small basic libc
50 include support (especially useful for floppy disks). Of course, you
51 can also use standard headers, although they are slower to compile.
53 You can begin your C script with '#!/usr/local/bin/tcc' on the first
54 line and set its execute bits (chmod a+x your_script). Then, you can
55 launch the C code as a shell or perl script :-) The command line
56 arguments are put in 'argc' and 'argv' of the main functions, as in
57 ANSI C.
59 3) Examples
61 ex1.c: simplest example (hello world). Can also be launched directly
62 as a script: './ex1.c'.
64 ex2.c: more complicated example: find a number with the four
65 operations given a list of numbers (benchmark).
67 ex3.c: compute fibonacci numbers (benchmark).
69 ex4.c: more complicated: X11 program. Very complicated test in fact
70 because standard headers are being used !
72 ex5.c: 'hello world' with standard glibc headers.
74 tcc.c: TCC can of course compile itself. Used to check the code
75 generator.
77 tcctest.c: auto test for TCC which tests many subtle possible bugs. Used
78 when doing 'make test'.
80 4) Full Documentation
82 Please read tcc-doc.html to have all the features of TCC.
84 License:
85 -------
87 TCC is distributed under the GNU General Public License (see COPYING
88 file). 
90 License may be changed to LGPL or X11 style, so I would prefer that
91 you indicate in submitted patches that you accept such a change.
93 Fabrice Bellard.