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' 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
  32
  33 *** TCC currently only works on Linux x86 with glibc >= 2.1 ***.
  34
  35 Type 'make install' to compile and install tcc in /usr/local/bin and
  36 /usr/local/lib/tcc.
  37
  38 Or type 'make all' to only compile it.
  39
  40 Type 'make libinstall' to compile and install libtcc.
  41 Or type 'make libtcc_test' to only compile it.
  42
  43 2) Introduction
  44
  45 We assume here that you know ANSI C. Look at the example ex1.c to know
  46 what the programs look like.
  47
  48 The include file <tcclib.h> can be used if you want a small basic libc
  49 include support (especially useful for floppy disks). Of course, you
  50 can also use standard headers, although they are slower to compile.
  51
  52 You can begin your C script with '#!/usr/local/bin/tcc' on the first
  53 line and set its execute bits (chmod a+x your_script). Then, you can
  54 launch the C code as a shell or perl script :-) The command line
  55 arguments are put in 'argc' and 'argv' of the main functions, as in
  56 ANSI C.
  57
  58 3) Examples
  59
  60 ex1.c: simplest example (hello world). Can also be launched directly
  61 as a script: './ex1.c'.
  62
  63 ex2.c: more complicated example: find a number with the four
  64 operations given a list of numbers (benchmark).
  65
  66 ex3.c: compute fibonacci numbers (benchmark).
  67
  68 ex4.c: more complicated: X11 program. Very complicated test in fact
  69 because standard headers are being used !
  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 License:
  84 -------
  85
  86 TCC is distributed under the GNU General Public License (see COPYING
  87 file).
  88
  89 License may be changed to LGPL or X11 style, so I would prefer that
  90 you indicate in submitted patches that you accept such a change.
  91
  92 Fabrice Bellard.