README

   1 Tiny C Compiler - C Scripting Everywhere - The Smallest ANSI C compiler
   2 -----------------------------------------------------------------------
   3
   4 Features:
   5 --------
   6
   7 - SMALL! You can compile and execute C code everywhere, for example on
   8   rescue disks.
   9
  10 - FAST! tcc generates optimized x86 code. No byte code
  11   overhead. Compile, assemble and link about 7 times faster than 'gcc
  12   -O0'.
  13
  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.
  17
  18 - SAFE! tcc includes an optional memory and bound checker. Bound
  19   checked code can be mixed freely with standard code.
  20
  21 - Compile and execute C source directly. No linking or assembly
  22   necessary. Full C preprocessor included.
  23
  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.
  27
  28 Documentation:
  29 -------------
  30
  31 1) Installation on a i386 Linux host (for Windows read tcc-win32.txt)
  32
  33    ./configure
  34    make
  35    make test
  36    make install
  37
  38 By default, tcc is installed in /usr/local/bin.
  39 ./configure --help  shows configuration options.
  40
  41
  42 2) Introduction
  43
  44 We assume here that you know ANSI C. Look at the example ex1.c to know
  45 what the programs look like.
  46
  47 The include file <tcclib.h> can be used if you want a small basic libc
  48 include support (especially useful for floppy disks). Of course, you
  49 can also use standard headers, although they are slower to compile.
  50
  51 You can begin your C script with '#!/usr/local/bin/tcc -run' on the first
  52 line and set its execute bits (chmod a+x your_script). Then, you can
  53 launch the C code as a shell or perl script :-) The command line
  54 arguments are put in 'argc' and 'argv' of the main functions, as in
  55 ANSI C.
  56
  57 3) Examples
  58
  59 ex1.c: simplest example (hello world). Can also be launched directly
  60 as a script: './ex1.c'.
  61
  62 ex2.c: more complicated example: find a number with the four
  63 operations given a list of numbers (benchmark).
  64
  65 ex3.c: compute fibonacci numbers (benchmark).
  66
  67 ex4.c: more complicated: X11 program. Very complicated test in fact
  68 because standard headers are being used ! As for ex1.c, can also be launched
  69 directly as a script: './ex4.c'.
  70
  71 ex5.c: 'hello world' with standard glibc headers.
  72
  73 tcc.c: TCC can of course compile itself. Used to check the code
  74 generator.
  75
  76 tcctest.c: auto test for TCC which tests many subtle possible bugs. Used
  77 when doing 'make test'.
  78
  79 4) Full Documentation
  80
  81 Please read tcc-doc.html to have all the features of TCC.
  82
  83 Additional information is available for the Windows port in tcc-win32.txt.
  84
  85 License:
  86 -------
  87
  88 TCC is distributed under the GNU Lesser General Public License (see
  89 COPYING file).
  90
  91 Fabrice Bellard.