-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathINSTALL
84 lines (50 loc) · 2.2 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
Installation Instructions
-------------------------
Please follow the instructions below to build rat with cmake.
Pre-requisites
--------------
You will need the 'cmake' build system installed in order to build rat
from source.
More information on cmake can be obtained at http://cmake.org
Basic Installation
------------------
Briefly, these shell commands will unpack, build and install rat:
$ tar xzf rat-1.0.0.tar.gz [1]
$ cd rat-1.0.0 [2]
$ cmake . [3]
$ make [4]
$ make test [5]
$ sudo make install [6]
$ cd .. ; rm -r rat-1.0.0 [7]
These commands are explained below:
1. Unpacks the source tarball. This creates the directory rat-1.0.0,
containing all the code.
2. Change directory to the root of the distribution.
3. Invokes cmake to scan for dependencies and machine-specific details, then
generate the makefiles. This may take a minute.
4. Builds rat. This may take a minute.
5. Optional step that runs the unit tests. On completion, will report the
number of passing and failing tests. There should be zero failing tests.
If you see failing tests, please report this.
6. Installs the program, documentation and other data files.
7. Removes the temporary directory.
Uninstallation
--------------
To uninstall rat, you need the Makefiles, so if you deleted them in step 7
above, they must first be regenerated by following steps [1], [2] and [3]. Then
simply run:
$ sudo make uninstall TODO TODO TODO -- cmake doesn't include uninstall
Rat Build Notes
----------------
Rat has dependencies that are detected by cmake in almost all cases, but there
are situations and operating systems that mean you will need to offer a little help.
If rat will not build on your system, first take a look at the Operating System
notes below. If this doesn't help, then go to the Troubleshooting section,
which includes instructions on how to contact us for help.
Operating System Notes
----------------------
...
Troubleshooting
---------------
...
---