Change BUILDING to only discuss 110.49+
[bpt/mlt.git] / BUILDING
1 ===================
2 System requirements
3 ===================
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.
12 =============
13 Configuration
14 =============
16 If it is possible for you to modify a file /etc/mlt.conf, then you
17 can edit this file to set various options related to locations of
18 important files on your file system. In particular, you may want to
19 set the 'compiler', 'lib', and 'sml' options (documented in the
20 manual) if you have SML/NJ installed somewhere besides /usr/local/sml
21 or the mlt src directory somewhere besides /usr/local/share/mlt/src.
22 If you can't modify /etc/mlt.conf, then you can change the first
23 variable definition in src/config.sml to a different path, or you can
24 leave it as is and provide all configuration in the local mlt.conf
25 file for each project.
27 You should also edit the paths in the simple install script in this
28 directory if you want to install system-wide binaries and scripts to
29 somewhere besides /usr/local/bin.
31 These changes may be made for you by a fancy configuration program in
32 a future release.
35 ========
36 Building
37 ========
39 All sources may be built by running the build script in this
40 directory. It does a clean re-build of all source files and stabilizes
41 all libraries produced. The build script is not appropriate for use
42 during development. Use the standard SML/NJ CM mechanisms if you are
43 changing the code and don't want to recompile everything each time.
45 [There is probably a better way to do this, but I haven't figured one
46 out yet.]