Add a readme for coders. (should go when makefile)

This commit is contained in:
Léonard Gérard 2011-11-14 11:03:47 +01:00
parent cf1e79efc8
commit ffa37f78af
2 changed files with 35 additions and 0 deletions

13
README_CODER.txt Normal file
View file

@ -0,0 +1,13 @@
*** Scripts:
** clean_heptc
* Arguments: none.
* Usages: used to remove heptc binaries and compiled files. It's main goal is to do a fresh compilation. heptc script may be called right after this to recompile all the things needed.
** heptc
* Arguments: see heptc -h
* Usages: wrap the real compiler in order to recompile it if it doesn't exists, and to recompile pervasives if needed. calling clean_heptc before it will ensure recompilation of everything.
*** Code organization:

22
config Normal file
View file

@ -0,0 +1,22 @@
srcdir = .
top_srcdir = .
prefix = /opt/local
exec_prefix = ${prefix}
bindir = ${exec_prefix}/bin
libdir = ${exec_prefix}/lib
INSTALL= /usr/bin/install -c
MAKE= @MAKE@
BUILD= _build
COMPILER=heptc
SIMULATOR=hepts
INSTALL_BINDIR=$(bindir)
INSTALL_LIBDIR=$(libdir)/heptagon
STDLIB_DIR=${exec_prefix}/lib/heptagon
OCAMLBUILD=STDLIB=$(STDLIB_DIR) ocamlbuild
TARGET=byte
ENABLE_SIMULATOR=yes