]>
Commit | Line | Data |
---|---|---|
8356cc1d | 1 | |
2 | ================================ | |
3 | dHLT - Dimuon High level Trigger | |
4 | ================================ | |
5 | ||
6 | This module is the implementation of the dHLT algorithm. | |
7 | ||
8 | ||
9 | Building: | |
10 | ========= | |
11 | ||
12 | 1) To build the dHLT modules type the following command in the shell in the top | |
13 | directory of the dHLT project: | |
14 | ||
15 | > make | |
16 | ||
17 | ||
18 | 2) To generate a distribution tar.gz file: | |
19 | ||
20 | > make dist | |
21 | ||
22 | The distribution archive will be found in the same directory as this readme file. | |
23 | ||
24 | ||
25 | 3) To generate a distribution for debugging: | |
26 | ||
27 | > make debug-dist | |
28 | ||
29 | ||
30 | 4) To compile all objects in debug mode for debugging with gdb for example: | |
31 | ||
32 | > make debug | |
33 | ||
34 | ||
35 | 5) To run build process in verbose mode: | |
36 | ||
37 | > make verbose | |
38 | ||
39 | ||
40 | 6) To generate source code documentation using doxygen: | |
41 | ||
42 | > make doc | |
43 | ||
44 | ||
45 | 7) To remove all intermediate files generated during the build process (excluding | |
46 | binaries and libraries): | |
47 | ||
48 | > make clean | |
49 | ||
50 | ||
51 | 8) To remove all files generated during the build process (including output | |
52 | binaries and libraries): | |
53 | ||
54 | > make clean-all | |
55 | ||
56 | ||
57 | ||
58 | Directories: | |
59 | ============ | |
60 | ||
61 | src/ | |
62 | Contains all source code. | |
63 | ||
64 | examples/ | |
65 | Contains scripts for running certain example uses of the dHLT | |
66 | ||
67 | ||
68 | macros/ | |
69 | Contains ROOT and AliRoot macros used to run parts of the software. | |
70 | Can contain other scripts also. | |
71 | ||
72 | ||
73 | build/ | |
74 | Contains all files (such as make files) required to build the binaries and libraries. | |
75 | ||
76 | ||
77 | doc/ | |
78 | Contains any specification or design documentation. | |
79 | (BB 26/11/04) Also contains a dHLTconfig file for generating doxygen | |
80 | documentation easily. | |
81 | ||
82 | Generated Directories: | |
83 | ====================== | |
84 | ||
85 | bin/ | |
86 | Contains binary executables. | |
87 | ||
88 | ||
89 | lib/ | |
90 | Contains libraries (shared objects / DLL's). | |
91 | ||
92 | ||
93 | include/ | |
94 | Contains include C++ header files required to compile against the libraries in lib/ | |
95 | ||
96 | srcdoc/ | |
97 | Documentation generated from the source code using doxygen is placed into this | |
98 | directory. | |
99 | ||
100 | output/ | |
101 | All temporary files that get generated during the build process such as .d and .o files | |
102 | are written to this directory. The directory contains a subdirectory for every module | |
103 | built containing that modules specific files. | |
104 | ||
105 | ||
106 | Files: | |
107 | =================== | |
108 | ||
109 | README | |
110 | This file. Should add any general or important information to help get people started | |
111 | with working with this module. | |
112 | ||
113 | BUGS | |
114 | Any known bugs are described in this file. Any new bugs discovered with this module | |
115 | should be added to this file. Please read the file header for more details. | |
116 | ||
117 | TODO | |
118 | This is a list describing things that need to be done. It can also contain a wish list, | |
119 | i.e. things that would be nice to implement in the future. Read the files header for | |
120 | more details. | |
121 | ||
122 |