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/x86_64/arm Linux/OSX/FreeBSD host (for Windows read tcc-win32.txt)
  32
  33    ./configure
  34    gmake
  35    gmake test
  36    gmake install
  37
  38 Alternatively, out-of-tree builds are supported: you may use different
  39 directories to hold build objects, kept separate from your source tree:
  40
  41    mkdir _build
  42    cd _build
  43    ../configure
  44    gmake
  45    gmake test
  46    gmake install
  47
  48 Texi2html must be installed to compile the doc.
  49 By default, tcc is installed in /usr/local/bin.
  50 ./configure --help  shows configuration options.
  51
  52
  53 2) Introduction
  54
  55 We assume here that you know ANSI C. Look at the example ex1.c to know
  56 what the programs look like.
  57
  58 The include file <tcclib.h> can be used if you want a small basic libc
  59 include support (especially useful for floppy disks). Of course, you
  60 can also use standard headers, although they are slower to compile.
  61
  62 You can begin your C script with '#!/usr/local/bin/tcc -run' on the first
  63 line and set its execute bits (chmod a+x your_script). Then, you can
  64 launch the C code as a shell or perl script :-) The command line
  65 arguments are put in 'argc' and 'argv' of the main functions, as in
  66 ANSI C.
  67
  68 3) Examples
  69
  70 ex1.c: simplest example (hello world). Can also be launched directly
  71 as a script: './ex1.c'.
  72
  73 ex2.c: more complicated example: find a number with the four
  74 operations given a list of numbers (benchmark).
  75
  76 ex3.c: compute fibonacci numbers (benchmark).
  77
  78 ex4.c: more complicated: X11 program. Very complicated test in fact
  79 because standard headers are being used ! As for ex1.c, can also be launched
  80 directly as a script: './ex4.c'.
  81
  82 ex5.c: 'hello world' with standard glibc headers.
  83
  84 tcc.c: TCC can of course compile itself. Used to check the code
  85 generator.
  86
  87 tcctest.c: auto test for TCC which tests many subtle possible bugs. Used
  88 when doing 'make test'.
  89
  90 4) Full Documentation
  91
  92 Please read tcc-doc.html to have all the features of TCC.
  93
  94 Additional information is available for the Windows port in tcc-win32.txt.
  95
  96 License:
  97 -------
  98
  99 TCC is distributed under the GNU Lesser General Public License (see
 100 COPYING file).
 101
 102 Fabrice Bellard.