1. # $Source$
  2. # $State$
  3. # $Revision$
  5. ===================================
  6. © 1987-2005 Vrije Universiteit, Amsterdam
  7. 2007-04-24
  9. ============
  10. The Amsterdam Compiler Kit is a complete compiler toolchain consisting of
  11. front end compilers for a number of different languages, code generators,
  12. support libraries, and all the tools necessary to go from source code to
  13. executable on any of the platforms it supports.
  14. This is an early prerelease of the upcoming version 6.0 release. Not a
  15. lot is supported, the build mechanism needs work, and a lot of things are
  16. probably broken. However, what's there should be sufficient to get things
  17. done and to evaluate how the full 6.0 release should work.
  19. =======
  20. Languages:
  21. ANSI C, Pascal, Modula 2. K&R is supported via the ANSI C compiler.
  22. Platforms:
  23. pc86 produces bootable floppy disk images for 8086 PCs
  24. linux386 produces ELF executables for PC Linux systems
  26. ============
  27. The version 6.0 build mechanism has been completely rewritten and is based
  28. around the Prime Mover build tool (see for more
  29. information). Installation ought to be fairly straightforward.
  30. Requirements:
  31. - an ANSI C compiler. Currently, I'm afraid, it's hard-coded to use gcc.
  32. To change, try changing the variable definitions in first/ This also
  33. needs to be available as 'cc' from the shell.
  34. - about 20MB free in /tmp (or some other temporary directory).
  35. - about 6MB in the target directory.
  36. Instructions:
  37. - edit There's a small section at the top containing some editable
  38. variables. Probably the only one you may want to edit is PREFIX, which
  39. changes where the ACK installs to.
  40. - Run:
  41. ./pm configure
  42. ...from the command line. This will write out a configuration file.
  43. - Run:
  44. ./pm
  45. ...from the command line. This will actually do the build. This takes
  46. about two minutes on my 1.6GHz Athlon Linux machine and about 30 on my
  47. 166MHz Pentium OpenBSD machine.
  48. - Run:
  49. ./pm install
  50. ...from the command line (possibly with sudo). This will install the built
  51. ACK into whatever directory you nominated in PREFIX.
  52. The ACK should now be ready to use.
  53. USAGE
  54. =====
  55. Currently I haven't sorted out all the documentation --- it's supplied in the
  56. distribution, but not all of it gets installed yet --- so here is a quickstart
  57. guide.
  58. The main command to use is 'ack'. This invokes the compiler and the linker.
  59. Some useful options include:
  60. -m<platform> build for the specified platform
  61. -o <file> specifies the output file
  62. -c produce a .o file
  63. -c.s produce a .s assembly file
  64. -O enable optimisation
  65. -ansi compile ANSI C (when using the C compiler)
  66. <file> build file
  67. ack figures out which language to use from the file extension:
  68. .c C (ANSI or K&R)
  69. .b Basic
  70. .mod Modula-2
  71. .ocm Occam 1
  72. .p Pascal
  73. .o object files
  74. .s assembly files
  75. For further information, see the man page (which actually does get
  76. installed, but is rather out of date).
  77. There are some (known working) example programs in the 'examples' directory.
  78. A sample command line is:
  79. ack -mlinux386 -O examples/paranoia.c
  81. =======
  82. There are some things you should be aware of.
  83. - Look at plat/linux386/README and plat/pc86/README for information about the
  84. two supported platforms.
  85. - The library support is fairly limited; for C, it's at roughly the ANSI C
  86. level, and for the other languages it's similar.
  87. - When compiling languages other than C, the ACK will usually look at the
  88. first character of the file. If it's a #, then the file will be run through
  89. the C preprocessor anyway.
  90. - BSD systems may need to up the number of file descriptors (e.g.
  91. 'ulimit -n 200') before the ACK will compile.
  92. - The ACK uses its own .o format. You won't be able to mix the ACK's object
  93. files and another compiler's.
  95. ==========
  96. The ACK is mature, well-tested software, but the environment in which it was
  97. developed for and tested under is rather different from that available on
  98. today's machines. There will probably be little in the way of logical bugs,
  99. but there may be many compilation and API bugs.
  100. If you wish to use the ACK, *please* join the mailing list. We are interested
  101. in any reports of success and particularly, failure. If it does fail for you,
  102. we would love to know why, in as much detail as possible. Bug fixes are even
  103. more welcome.
  104. The ACK is licensed under a BSD-like license. Please see the 'Copyright' file
  105. for the full text.
  106. You can find the mailing list on the project's web site:
  108. Please enjoy.
  109. David Given (dtrg on Sourceforge)
  111. 2007-04-24