Basic structure
===============

The directory structure of x is below

       $VXLSRC/vcl
               core/vnl
                   /vul
                   /vbl
                   /vil
                   /vgl
                   /vsl
                  ...
               v3p/netlib
                  /jpeg
                  ...
               config/cmake
               contrib/

vcl
     is the C++ compatibility layer (see vcl).

core
     contains the core x libraries.

v3p
     (v-third-party) contains code that is available elsewhere and is used in implementing x. v3p/netlib contains cleaned-up C versions of the high-quality Fortran code. v3p/jpeg and others contain image file format code used by vil. In theory, you don't need any of the v3p libraries if you have locally installed versions. In practice, you need v3p/netlib but not the others.  the

config/cmake
     contains the configuration files used by the CMake build system (see CMake).

Other packages
==============

On the repository and some x distributions, you will find several other packages in the contrib directory.

gel
     Published libraries from General Electric Global Research.

oxl
     Published libraries from the Robots Research Group at Oxford University.

mul
     Published libraries from Imaging Science and Biomedical Engineering at the University of Manchester.

rpl
     Published libraries from Rensselaer Polytechnic Institute

brl
     Published libraries from Brown University

tbl
     A set of image processing libraries.

oul
     Published libraries from Otago University

conversions
     A set of routines for converting between various x and non-x types.

These modules are presented as useful code, with even less guarantees than x (which is not to suggest that we guarantee anything about x).  In particular they may not work as advertised. They may not be documented. If you find them useful, and think they deserve full x-status please contact the library's author to see about having the code tidied up and promoted to x.

You can find any overview documentation about these modules from the vxl homepage (https://vxl.github.io/) by following the ``documentation'' link.

Subversion (svn) Repository
===========================

The VXL repository is provided by GitHUb! The instructions for downloading x are documented at https://vxl.github.io/#download.