1@section Basic structure
2
3The directory structure of @vxl{x} is below
4@example
5  $VXLSRC/vcl
6          core/vnl
7              /vul
8              /vbl
9              /vil
10              /vgl
11              /vsl
12             @dots{}
13          v3p/netlib
14             /jpeg
15             @dots{}
16          config/cmake
17          contrib/
18@end example
19
20@table @samp
21@item vcl
22is the C++ compatibility layer (@pxref{vcl}).
23
24@item core
25contains the core @vxl{x} libraries.
26
27@item v3p
28(v-third-party) contains code that is available elsewhere and is used
29in implementing @vxl{x}. @code{v3p/netlib} contains cleaned-up C
30versions of the high-quality Fortran code. @code{v3p/jpeg} and others
31contain image file format code used by vil. In theory, you don't need
32any of the v3p libraries if you have locally installed versions. In
33practice, you need @code{v3p/netlib} but not the others.  the
34
35@item config/cmake
36contains the configuration files used by the CMake build system
37(@pxref{CMake}).
38
39@end table
40
41@anchor{struct_other_packages}
42@section Other packages
43
44On the repository and some @vxl{x} distributions, you will find several other
45packages in the @samp{contrib} directory.
46
47@cindex gel
48@cindex oxl
49@cindex mul
50@cindex rpl
51@cindex brl
52@cindex tbl
53@cindex oul
54
55@table @samp
56@item gel
57Published libraries from General Electric Global Research.
58@item oxl
59Published libraries from the Robots Research
60Group at Oxford University.
61@item mul
62Published libraries from Imaging Science and Biomedical Engineering
63at the University of Manchester.
64@item rpl
65Published libraries from Rensselaer Polytechnic
66Institute
67@item brl
68Published libraries from Brown University
69@item tbl
70A set of image processing libraries.
71@item oul
72Published libraries from Otago University
73@item conversions
74A set of routines for converting between various @vxl{x} and non-@vxl{x} types.
75@end table
76
77These modules are presented as useful code, with even less guarantees
78than @vxl{x} (which is not to suggest that we guarantee anything about
79@vxl{x}).  In particular they may not work as advertised. They may not
80be documented. If you find them useful, and think they deserve full
81@vxl{x}-status please contact the library's author to see about having
82the code tidied up and promoted to @vxl{x}.
83
84You can find any overview documentation about these modules from the
85@uref{https://vxl.github.io/,vxl homepage} by following the
86``documentation'' link.
87
88@section Subversion (svn) Repository
89
90The VXL repository is provided by GitHUb! The
91instructions for downloading @vxl{x} are documented at
92@url{https://vxl.github.io/#download}.
93