-
Notifications
You must be signed in to change notification settings - Fork 2
/
INSTALL
118 lines (80 loc) · 2.68 KB
/
INSTALL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
________________
INSTALLING MCL
________________
1 Introduction
==============
Most of MCL's source is contained in literal programming Org-mode
files with extension ".org". This document only describes the initial
part of extracting the actual sources from the literate programming
files, a process that is called 'tangling'. From there we generate
HTML pages with the full instructions.
2 Prerequisites
===============
We need the following software: `git', `emacs' version 25 or higher,
and a sufficiently compatible shell such as `bash'. In addition, we
need the package `org-build-tools' that we retrieve with `git'.
3 Obtaining org-build-tools
===========================
The package `org-build-tools' is needed by MCL, but is in principle
independent of `MCL'. It is therefore possible to place it in a
non-intrusive way, for example in `$HOME/.mcl_util/'. For the rest of
this document we assume that this is the directory to store the
utilities.
We can retrieve org-build-tools with:
,----
| mkdir ~/.mcl_util
| cd ~/.mcl_util
| git clone https://github.com/JungleComputing/org-build-tools.git
`----
We need to create the environment variable `ORG_BUILD_TOOLS' for
installing MCL, so in your shell initialization script (for example
`.bashrc') add:
,----
| export ORG_BUILD_TOOLS=$HOME/.mcl_util/org-build-tools
`----
Restart the shell our perform:
,----
| source ~/.bashrc
`----
4 Obtaining MCL
===============
We can retrieve MCL with:
,----
| git clone https://github.com/JungleComputing/mcl.git
`----
We can now retrieve all the submodules:
,----
| cd mcl
|
| git submodule init
| git submodule update
`----
To be able to create the documentation for MCL, the scripts need to
know the location of the root directory of MCL. We can set this
variable by adding the following to the shell initialization script
(for example `/.bashrc'):
,----
| export MCL_ROOT_DIR=/path/to/mcl
`----
Then load the initialization script:
,----
| source ~/.bashrc
`----
5 Tangling MCL
==============
From the MCL root directory we can tangle all the `.org' files. These
scripts make use of `org-build-tools'.
,----
| ./scripts/tangle-mcl
`----
6 Generate the documentation
============================
The overall installation documentation is described in
`doc/installing_mcl.org' which is an ASCII file and is legible with
any editor. However, it is also possible to create documentation in
the form of HTML pages with the command:
,----
| ./scripts/export-to-html-mcl
`----
The file `doc/index.html' will refer you to the full installation
process.