| 1 |
Installation Instructions |
| 2 |
------------------------- |
| 3 |
|
| 4 |
Please follow the instructions below to build clog with cmake. |
| 5 |
|
| 6 |
|
| 7 |
Pre-requisites |
| 8 |
-------------- |
| 9 |
|
| 10 |
You will need the 'cmake' build system installed in order to build clog |
| 11 |
from source. |
| 12 |
|
| 13 |
More information on cmake can be obtained at http://cmake.org |
| 14 |
|
| 15 |
|
| 16 |
Basic Installation |
| 17 |
------------------ |
| 18 |
|
| 19 |
Briefly, these shell commands will unpack, build and install clog: |
| 20 |
|
| 21 |
$ tar xzf clog-1.3.0.tar.gz [1] |
| 22 |
$ cd clog-1.3.0 [2] |
| 23 |
$ cmake . [3] |
| 24 |
$ make [4] |
| 25 |
$ make test [5] |
| 26 |
$ sudo make install [6] |
| 27 |
$ cd .. ; rm -r clog-1.3.0 [7] |
| 28 |
|
| 29 |
These commands are explained below: |
| 30 |
|
| 31 |
1. Unpacks the source tarball. This creates the directory clog-1.2.0, |
| 32 |
containing all the code. |
| 33 |
|
| 34 |
2. Change directory to the root of the distribution. |
| 35 |
|
| 36 |
3. Invokes cmake to scan for dependencies and machine-specific details, then |
| 37 |
generate the makefiles. This may take a minute. |
| 38 |
|
| 39 |
4. Builds clog. This may take a minute. |
| 40 |
|
| 41 |
5. Optional step that runs the unit tests. On completion, will report the |
| 42 |
number of passing and failing tests. There should be zero failing tests. |
| 43 |
If you see failing tests, please report this. |
| 44 |
|
| 45 |
6. Installs the program, documentation and other data files. |
| 46 |
|
| 47 |
7. Removes the temporary directory. |
| 48 |
|
| 49 |
|
| 50 |
Uninstallation |
| 51 |
-------------- |
| 52 |
|
| 53 |
To uninstall clog, you need the Makefiles, so if you deleted them in step 7 |
| 54 |
above, they must first be regenerated by following steps [1], [2] and [3]. Then |
| 55 |
simply run: |
| 56 |
|
| 57 |
$ sudo make uninstall TODO TODO TODO -- cmake doesn't include uninstall |
| 58 |
|
| 59 |
|
| 60 |
Clog Build Notes |
| 61 |
---------------- |
| 62 |
|
| 63 |
Clog has dependencies that are detected by cmake in almost all cases, but there |
| 64 |
are situations and operating systems that mean you will need to offer a little help. |
| 65 |
|
| 66 |
If clog will not build on your system, first take a look at the Operating System |
| 67 |
notes below. If this doesn't help, then go to the Troubleshooting section, |
| 68 |
which includes instructions on how to contact us for help. |
| 69 |
|
| 70 |
|
| 71 |
|
| 72 |
Operating System Notes |
| 73 |
---------------------- |
| 74 |
|
| 75 |
... |
| 76 |
|
| 77 |
|
| 78 |
Troubleshooting |
| 79 |
--------------- |
| 80 |
|
| 81 |
... |
| 82 |
|
| 83 |
|
| 84 |
--- |