Even on Darwin, tcc should display Linux
[tinycc.git] / README
blob3a3f90be47ba187e675efe7e2261e9f644583cae
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 on a i386/x86_64/arm Linux/OSX/FreeBSD host
33    ./configure
34    make
35    make test
36    make install
38    Notes: For OSX and FreeBSD, gmake should be used instead of make.
39    For Windows read tcc-win32.txt.
41 makeinfo must be installed to compile the doc.  By default, tcc is
42 installed in /usr/local/bin.  ./configure --help  shows configuration
43 options.
46 2) Introduction
48 We assume here that you know ANSI C. Look at the example ex1.c to know
49 what the programs look like.
51 The include file <tcclib.h> can be used if you want a small basic libc
52 include support (especially useful for floppy disks). Of course, you
53 can also use standard headers, although they are slower to compile.
55 You can begin your C script with '#!/usr/local/bin/tcc -run' on the first
56 line and set its execute bits (chmod a+x your_script). Then, you can
57 launch the C code as a shell or perl script :-) The command line
58 arguments are put in 'argc' and 'argv' of the main functions, as in
59 ANSI C.
61 3) Examples
63 ex1.c: simplest example (hello world). Can also be launched directly
64 as a script: './ex1.c'.
66 ex2.c: more complicated example: find a number with the four
67 operations given a list of numbers (benchmark).
69 ex3.c: compute fibonacci numbers (benchmark).
71 ex4.c: more complicated: X11 program. Very complicated test in fact
72 because standard headers are being used ! As for ex1.c, can also be launched
73 directly as a script: './ex4.c'.
75 ex5.c: 'hello world' with standard glibc headers.
77 tcc.c: TCC can of course compile itself. Used to check the code
78 generator.
80 tcctest.c: auto test for TCC which tests many subtle possible bugs. Used
81 when doing 'make test'.
83 4) Full Documentation
85 Please read tcc-doc.html to have all the features of TCC.
87 Additional information is available for the Windows port in tcc-win32.txt.
89 License:
90 -------
92 TCC is distributed under the GNU Lesser General Public License (see
93 COPYING file).
95 Fabrice Bellard.