Annotation of /trunk/INSTALL

Parent Directory | Revision Log

---

Revision 2660 - (view) (download)

1 :	jhr	123	Build instructions for the Diderot compiler
2 :
3 :	jhr	1113	===============
4 :			PREREQUISITES
5 :			===============
6 :	jhr	2660
7 :	jhr	1113	You must have TEEM installed, which you can get from
8 :	jhr	123
9 :	glk	1337	http://teem.sourceforge.net/download/index.html
10 :	jhr	1113
11 :	jhr	2660	You also must have SML/NJ (version 110.75 or later) installed, which you can
12 :	jhr	1113	get from
13 :
14 :	jhr	2660	http://smlnj.org/dist/working/index.html
15 :	jhr	1113
16 :	jhr	1270	Diderot is currently supported on Linux and Mac OS X. It requires a system that is
17 :	jhr	2568	capable of running 64-bit executables. Note that SML/NJ is a 32-bit program, so
18 :			on Linux systems you must also have the 32-bit compatibility libraries installed
19 :			(the exact libraries/packages depends on your distribution).
20 :	jhr	1113
21 :			===============
22 :	glk	1266	SOURCE CHECKOUT
23 :			===============
24 :	jhr	2660
25 :	jhr	1270	You can checkout the stable version of the Diderot source tree with:
26 :	glk	1266
27 :	glk	1337	svn co https://svn.smlnj-gforge.cs.uchicago.edu/svn/diderot/trunk diderot
28 :	glk	1266
29 :	glk	1337	An anonymous checkout is available via user name "anonsvn" and
30 :			password "anonsvn". At times, there may also be unstable or
31 :			experimental development branches. You can explore these using the
32 :			web interface at
33 :	jhr	1270
34 :	glk	1337	https://smlnj-gforge.cs.uchicago.edu/scm/viewvc.php/?root=diderot
35 :	jhr	1270
36 :	glk	1266	===============
37 :	jhr	1113	CONFIGURATION
38 :			===============
39 :
40 :	jhr	1232	Run autoheader:
41 :
42 :	glk	1337	% autoheader -Iconfig
43 :	jhr	1232
44 :	jhr	123	Run autoconf:
45 :
46 :	glk	1337	% autoconf -Iconfig
47 :	jhr	123
48 :	jhr	1232	Configure the makefiles etc.
49 :	jhr	123
50 :	glk	1337	% ./configure --with-teem=/path/to/teem
51 :	jhr	123
52 :	glk	1337	where "/path/to/teem" is the full path of the directory
53 :			containing the "lib" and "include" directories containing
54 :			"libteem.{a,so,dylib}" and "teem/*.h", respectively.
55 :	jhr	1113
56 :	jhr	1640	You can also specify the location of the doxygen executable at
57 :			configuration time using the option
58 :
59 :			--with-doxygen=/path/to/doxygen
60 :
61 :			Doxygen (http://doxygen.org) is used to generate documentation
62 :			for the runtime system. If you have the Doxygen application
63 :			installed on the Mac, you should specify
64 :
65 :			--with-doxygen=/Applications/Doxygen.app/Contents/Resources/doxygen
66 :
67 :			(assuming that the Doxygen application is installed in the Applications
68 :			folder).
69 :
70 :	jhr	1113	===============
71 :			INSTALLATION
72 :			===============
73 :
74 :			From the root of the Diderot tree, run
75 :
76 :	glk	1337	% make local-install
77 :	jhr	1113
78 :	glk	1337	This command will build the Diderot compiler (bin/diderotc) and
79 :	jhr	2660	runtime support. Assuming that $ROOT is the root of the Diderot tree;
80 :			the above make command will create the following files and directories:
81 :
82 :			$ROOT/bin/diderotc -- the diderotc compiler script
83 :			$ROOT/bin/.heap -- contains the diderotc heap image (used by
84 :			the diderotc script)
85 :			$ROOT/lib -- various versions of the Diderot runtime system
86 :			compiled as ".o" files
87 :			$ROOT/include/Diderot -- the Diderot header files, which are needed to
88 :			compile the output of the diderotc compiler.
89 :
90 :			It is also possible to install the system outside the Diderot tree. To do so,
91 :			use the "--prefix" option to the configure command. For example:
92 :
93 :			% configure --with-teem=/path/to/teem --prefix=/usr/local/Diderot
94 :			% make install
95 :
96 :			will install the Diderot compiler, libraries, and headers in /usr/local/Diderot.

---

root@smlnj-gforge.cs.uchicago.edu	ViewVC Help
Powered by ViewVC 1.0.0