-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME_EN.txt
313 lines (264 loc) · 8.65 KB
/
README_EN.txt
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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
* README_EN.txt
* 2023.04.04
* 3dparty
1. DESCRIPTION
2. REPOSITORIES
3. CATALOG CONTENT DESCRIPTION
4. PREREQUISITES
5. DEPENDENCIES
6. EXTERNALS
7. USAGE
8. AUTHOR
-------------------------------------------------------------------------------
1. DESCRIPTION
-------------------------------------------------------------------------------
3dparty libraries with build scripts.
-------------------------------------------------------------------------------
2. REPOSITORIES
-------------------------------------------------------------------------------
Primary:
* https://github.com/andry81-3dparty/3dparty/branches
* https://github.com/andry81-3dparty/3dparty.git
First mirror:
* https://sf.net/p/andry81-3dparty/3dparty/HEAD/tree
* https://git.code.sf.net/p/andry81-3dparty/3dparty
Second mirror:
* https://bitbucket.org/andry81/3dparty/branches
* https://bitbucket.org/andry81/3dparty.git
-------------------------------------------------------------------------------
3. CATALOG CONTENT DESCRIPTION
-------------------------------------------------------------------------------
The `_3DPARTY_BUILD_SOURCES_ROOT` and `_3DPARTY_BUILD_OUTPUT_ROOT` variables
from the `config.0.vars` configuration file must point to the build sources
directory and to the build output directory respectively.
<root>
|
+- /`_config`
| | #
| | # Directory with build input configuration files.
| |
| +- /`cmake`
| | | #
| | | # Directory with cmake build input configuration files.
| | |
| | +- `config.0.vars.in`
| | #
| | # Configuration file for all libraries as an EXAMPLE (does not load
| | # actually).
| | #
| | # Is used to accumulate all library variables and should be used to
| | # build your own target project cmake configuration file which has
| | # particular dependent libraries.
| | #
| | # NOTE:
| | # The configuration file loads by cmake script from the
| | # `tacklelib` library.
| |
| +- /`src`
| #
| # Directory with build input configuration files specific for each
| # library.
|
+- /`_externals`
| #
| # Directory with external dependencies.
|
+- /`_out`
| | #
| | # Temporary directory with build output.
| |
| +- /`config`
| | #
| | # Directory with build output configuration files.
| |
+ +- /`build`
| | #
| | # Directory with build output
| | # Pointed by `_3DPARTY_BUILD_OUTPUT_ROOT` variable.
| |
| +- /`<platform>`
| | #
| | # Platform generic name.
| |
| +- /`<compiler>`
| | #
| | # Compiler generic name.
| |
| +- /`<arch>`
| | #
| | # Architecture generic name.
| |
| +- /`<category>`
| | #
| | # Sources category variant.
| |
| +- /`<library>`
| | #
| | # Library generic name.
| |
| +- /`<branch>`
| #
| # Particular library branch name.
|
+- /`_scripts`
| #
| # Projects with build scripts.
|
+- /`src`
| | #
| | # Directory with build sources.
| | # Pointed by `_3DPARTY_BUILD_SOURCES_ROOT` variable.
| |
| +- /`<category>`
| | #
| | # Sources category variant.
| |
| +- /`<library>`
| | #
| | # Library generic name.
| |
| +- /`<branch>`
| #
| # Particular library branch name.
|
+- /`tools`
| | #
| | # Directory with tool scripts.
| |
| +- `dump-externals.bat`
| #
| # Reads the `/src` directory using the predefined hierarchy to
| # print all found `.externals` files as a single file.
| # Additionally the script by default replaces all local relative paths
| # from `_externals/` to `src/<category>/<library>/`.
| # It is used to update the `.src` file from the `.externals` file in
| # each library repository.
| #
|
+- `.src`
#
# All library urls and branches to checkout altogether into the `/src`
# directory.
, where:
* <category>:
* `app` - application bundles
* `arc` - archiving libraries
* `gui` - UI libraries
* `log` - logging libraries
* `math` - mathematical libraries
* `net` - network libraries
* `sat` - satellite libraries
* `test` - testing libraries
* `utility` - utility libraries
* `xml` - xml libraries
* `yaml` - yaml libraries
* <platform>:
* `msvc` - Microsoft Visual Studio platform
* `cygwin` - Cygwin
* `msys` - Msys
* `mingw` - Mingw
* <compiler>:
* `vc10` - Microsoft Visual Studio 2010
* `vc11` - Microsoft Visual Studio 2011
* `vc12` - Microsoft Visual Studio 2012
* `vc14` - Microsoft Visual Studio 2015
* `vc2017` - Microsoft Visual Studio 2017
* `vc2019` - Microsoft Visual Studio 2019
* <arch>:
* `x86`
* `x64`
Example:
<root>
/src
/arc
/libarchive
/3_4_1_release
/xzutils
/5_2_4_release
/zlib
/1_2_11_release
/utility
/boost
/1_72_0_release
/_out
/build
/msvc
/vc2017
/x86
/arc
/libarchive
/3_4_1_release
/xzutils
/5_2_4_release
/zlib
/1_2_11_release
/utility
/boost
/1_72_0_release
-------------------------------------------------------------------------------
4. PREREQUISITES
-------------------------------------------------------------------------------
Currently used these set of OS platforms, externals, compilers, IDE's and
patches to run with or from:
1. OS platforms:
* Windows 7+ (MSVC/GCC targets, minimal version for the cmake 3.14)
* Cygwin 1.5+ or 3.0+ (GCC target):
https://cygwin.com
- to run scripts under cygwin
* Msys2 20190524+ (GCC target):
https://www.msys2.org
- to run scripts under msys2
* Linux Mint 18.3 x64 (GCC target)
2. Externals:
* `contools`
3. C++11 compilers:
* (primary) Microsoft Visual C++ 2015 Update 3 or Microsoft Visual C++ 2017
* (secondary) GCC 5.4+
4. IDE's:
* Microsoft Visual Studio 2015 Update 3
* Microsoft Visual Studio 2017
5. Patches:
Target repository with a 3dparty component sources must already contain all
patches and description with it.
-------------------------------------------------------------------------------
5. DEPENDENCIES
-------------------------------------------------------------------------------
Any project which is dependent on this project have has to contain the
`README_EN.deps.txt` description file for the common dependencies in the
Windows and in the Linux like platforms.
-------------------------------------------------------------------------------
6. EXTERNALS
-------------------------------------------------------------------------------
To checkout externals you must use the
[vcstool](https://github.com/dirk-thomas/vcstool) python module.
NOTE:
To install the module from the git repository:
>
python -m pip install git+https://github.com/dirk-thomas/vcstool
-------------------------------------------------------------------------------
7. USAGE
-------------------------------------------------------------------------------
1. Put `<root>` directory closer to the drive root to avoid a long paths issue
(260+ characters).
2. Install `vcstool` described in the `EXTERNALS` section.
3. Checkout externals into the `/_externals` directory.
>
cd <root>
vcs import < .externals
3. Checkout all/respective source libraries into the `/src` directory in
predefined form described in the `CATALOG CONTENT DESCRIPTION` section.
To checkout all sources:
>
cd <root>
vcs import < .src
CAUTION:
Beware of start downloading of all libraries!
NOTE:
To checkout specific sources you must create or use your own version of
the `.src` file.
5. Read `README_EN.txt` file from the `_scripts` directory to build specific
library.
-------------------------------------------------------------------------------
8. AUTHOR
-------------------------------------------------------------------------------
Andrey Dibrov (andry at inbox dot ru)