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