Add BUILDING
[hcoop/smlsql.git] / BUILDING
1 ===================
2 System requirements
3 ===================
4
5 This requires a "working version" of SML/NJ on a POSIX system. It's
6 best to use version 110.49 or later. Earlier versions have
7 incompatibilities, bugs, or both.
8
9
10 =============
11 Configuration
12 =============
13
14 Modify the parameters at the start of 'build' as appropriate for your
15 system.
16
17 These settings may be determined for you autotmatically by a fancy
18 configuration program in a future release.
19
20
21 ========
22 Building
23 ========
24
25 All sources may be built by running the 'build' script in this
26 directory. It does a clean re-build of all source files and stabilizes
27 all libraries produced. The build script is not appropriate for use
28 during development. Use the standard SML/NJ CM mechanisms if you are
29 changing the code and don't want to recompile everything each time.
30
31 [There is probably a better way to do this, but I haven't figured one
32 out yet.]
33
34
35 ===================
36 Using the libraries
37 ===================
38
39 After building, include libpq/sources.cm in an SML/NJ project's .cm
40 file. The libraries are stabilized, so people without write access to
41 the directory can use them without problems.