a040dcb6aae258f0a72c59beb34a81b2dcf89dde
[bpt/mlt.git] / BUILDING
1 ===================
2 System requirements
3 ===================
4
5 Compiling the mlt tool requires a "working version" of SML/NJ. It's
6 best to use version 110.49 or later. Earlier versions have
7 incompatibilities, bugs, or both. You may have problems with any
8 version whatsoever, though, since this stuff uses some SML/NJ compiler
9 internals, and they may change often.
10
11
12 =============
13 Configuration
14 =============
15
16 Modify the parameters in settings and src/settings.sml as appropriate
17 for your system.
18
19 If it is possible for you to modify a file /etc/mlt.conf, then you
20 can edit this file to set various options related to locations of
21 important files on your file system. In particular, you may want to
22 set the 'compiler', 'lib', and 'sml' options (documented in the
23 manual) if you have SML/NJ installed somewhere besides /usr/local/sml
24 or the mlt src directory somewhere besides /usr/local/share/mlt/src.
25 If you can't modify /etc/mlt.conf, then you can change the first
26 variable definition in src/config.sml to a different path, or you can
27 leave it as is and provide all configuration in the local mlt.conf
28 file for each project.
29
30 You should also edit the paths in the simple install script in this
31 directory if you want to install system-wide binaries and scripts to
32 somewhere besides /usr/local/bin.
33
34 These changes may be made for you by a fancy configuration program in
35 a future release.
36
37
38 ========
39 Building
40 ========
41
42 All sources may be built by running the build script in this
43 directory. It does a clean re-build of all source files and stabilizes
44 all libraries produced. The build script is not appropriate for use
45 during development. Use the standard SML/NJ CM mechanisms if you are
46 changing the code and don't want to recompile everything each time.
47
48 [There is probably a better way to do this, but I haven't figured one
49 out yet.]