Relicensing TinyCC
[tinycc.git] / README
blob809dd8d4b5d9285952762b68abee1ad4e37a2a54
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 toward 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/aarch64/riscv64
32    Linux/macOS/FreeBSD/NetBSD/OpenBSD hosts.
34    ./configure
35    make
36    make test
37    make install
39    Notes: For FreeBSD, NetBSD and OpenBSD, gmake should be used instead of make.
40    For Windows read tcc-win32.txt.
42 makeinfo must be installed to compile the doc.  By default, tcc is
43 installed in /usr/local/bin.  ./configure --help  shows configuration
44 options.
47 2) Introduction
49 We assume here that you know ANSI C. Look at the example ex1.c to know
50 what the programs look like.
52 The include file <tcclib.h> can be used if you want a small basic libc
53 include support (especially useful for floppy disks). Of course, you
54 can also use standard headers, although they are slower to compile.
56 You can begin your C script with '#!/usr/local/bin/tcc -run' on the first
57 line and set its execute bits (chmod a+x your_script). Then, you can
58 launch the C code as a shell or perl script :-) The command line
59 arguments are put in 'argc' and 'argv' of the main functions, as in
60 ANSI C.
62 3) Examples
64 ex1.c: simplest example (hello world). Can also be launched directly
65 as a script: './ex1.c'.
67 ex2.c: more complicated example: find a number with the four
68 operations given a list of numbers (benchmark).
70 ex3.c: compute fibonacci numbers (benchmark).
72 ex4.c: more complicated: X11 program. Very complicated test in fact
73 because standard headers are being used ! As for ex1.c, can also be launched
74 directly as a script: './ex4.c'.
76 ex5.c: 'hello world' with standard glibc headers.
78 tcc.c: TCC can of course compile itself. Used to check the code
79 generator.
81 tcctest.c: auto test for TCC which tests many subtle possible bugs. Used
82 when doing 'make test'.
84 4) Full Documentation
86 Please read tcc-doc.html to have all the features of TCC.
88 Additional information is available for the Windows port in tcc-win32.txt.
90 License:
91 -------
93 TCC is distributed under the GNU Lesser General Public License (see
94 COPYING file).
96 Fabrice Bellard.