README.txt

   1 ==============================================================================\r
   2  luatcc 1.0.0\r
   3 ==============================================================================\r
   4 ------------------------------------------------------------------------------\r
   5  About\r
   6 ------------------------------------------------------------------------------\r
   7 \r
   8 This is the first release of luatcc, a Lua binding for libtcc library. You can\r
   9 find documentation about luatcc at the following web address:\r
  10 \r
  11   http://luatcc.luaforge.net/\r
  12 \r
  13 ------------------------------------------------------------------------------\r
  14  Build instructions\r
  15 ------------------------------------------------------------------------------\r
  16 \r
  17 To build luatcc edit config-gcc.mak and then run make in the top directory:\r
  18 \r
  19 $ vi config-gcc.mak\r
  20 $ make\r
  21 $ make install\r
  22 \r
  23 ------------------------------------------------------------------------------\r
  24  TCC\r
  25 ------------------------------------------------------------------------------\r
  26 \r
  27 To use luatcc you need TCC. It is available at:\r
  28 \r
  29   http://fabrice.bellard.free.fr/tcc/\r
  30 \r
  31 Also, in the ext subdirectory of this package, you will find a patch named\r
  32 tcc-tcc_compile_named_string.patch that can be applied to tcc to improve its\r
  33 error messages when used with luatcc. This patch was written for TCC 0.9.23,\r
  34 but can be easily adapted to other versions. If you apply this patch, comment\r
  35 the last line of config-gcc.mak\r
  36 \r
  37 ------------------------------------------------------------------------------\r
  38  Testing the module\r
  39 ------------------------------------------------------------------------------\r
  40 \r
  41 In the test subdirectory you will find some test programs to check that\r
  42 everything is working properly. There is no automated test for the moment,\r
  43 look at each testx.lua file to have an idea of what each test does.\r
  44 \r
  45 ------------------------------------------------------------------------------\r
  46  Documentation & Support\r
  47 ------------------------------------------------------------------------------\r
  48 \r
  49 Documentation is available online at:\r
  50 \r
  51   http://luatcc.luaforge.net/\r
  52 \r
  53 All support is done through the luatcc users mailing list:\r
  54 \r
  55   luatcc-users@lists.luaforge.net\r
  56 \r
  57 To subscribe visit the following web page:\r
  58 \r
  59   http://lists.luaforge.net/mailman/listinfo/luatcc-users\r
  60 \r
  61 ------------------------------------------------------------------------------\r
  62  Credits & license\r
  63 ------------------------------------------------------------------------------\r
  64 This module is written by Jérôme Vuarand. It is originally based on lua-tcc\r
  65 module by Javier Guerra and has been extended to support a bigger part of\r
  66 libtcc API and to work as a Lua module loader.\r
  67 \r
  68 Luatcc is available under a MIT-style license. See LICENSE.txt.\r
  69 \r