|
|
Directory Structure
|
|
teem
|
|
|
|
Upon unpacking a tarball, or doing a
"cvs checkout teem", there will be a directory named something like
teem or teem-1.Nblah. It contains:
- README.txt : General pleasantries.
- src/ : All the individual teem libraries have subdirectories
in here; see below.
- cygwin/, darwin/, irix6.64/,
irix6.n32/, linux/, solaris/: All the unix-like
architecture-specific directories. Each of these contain:
- bin/: Where the makefiles put compiled "installed"
binaries (executables)
- lib/: Where the makefiles put "installed"
libraries (static and shared)
normally go
- obj/: Where the makefiles put object files during compilation,
and where libraries go when compiling "dev"
- purify/: Purify's cache directory
- win32/: Slightly different than the other architecture-specific
directories. The first three directories have the same role as on
unix/cygwin, but they are used by the project files, instead of the
makefiles.
- bin/: Where binaries go,
- lib/: For libteem.dll and libteem.lib
- obj/: Where object files go
- make/:
- vc6/: files specific to VC6
- vc7/: files specific to VC7 (Visual Studio .net)
- common/: files shared by VC6 and VC7
- bin/, lib/: These can be used as the locations
for "installed" binaries and libraries (instead of the architecture-specific
directories), when the environment variable TEEM_DEST is set to
this directory (the one containing bin/, lib/). This is
done, for instance, when creating the pre-built binary versions for
distribution
- include/: Where all "installed" header files go.
This also contains some teem*.h headers which are used
as tests on the the settings of various compiler variables.
The teem/src/ directory contains:
- LICENSE.txt:
The full text of the GNU Lesser General Public License.
- README.txt:
brief information about the different libraries, and a text version of
the inter-library dependency graph
- CHANGES.txt: high-level
description of changes between teem versions.
- TODO.txt: the long road ahead
in teem development.
- names.pl, unangle.pl: dinky little perl scripts
used sometimes during development or writing documentation
- preamble.c, preamble.mk: the LGPL preamble, included
in every file C source, header, and make file.
- GNUmakefile: Top-level makefile.
- make/:
- cygwin.mk, darwin.mk, irix6.mk,
linux.mk, solaris.mk: The architecture-specific makefiles.
All the variations in how GNU make behaves on different architectures
are based on these.
- template.mk, externals.mk: supplementary makefiles
- hex/: not a teem library at all-- stand-alone hex encoder
and decoder.
- bin/: source files for the teem "bins": the stand-alone
executables that link against various teem libraries.
- air, hest, biff, ell, nrrd,
unrrdu, dye, gage, bane, limn,
hoover, mite, ten, echo: The source
files for each library. Each one may contain:
- GNUmakefile: library-specific makefile: gives inter-library
dependency, and lists object files and tests for this library.
- CHANGES.txt: detailed library-specific changes between
teem versions
- TODO.txt: things remaining for this library
- test/: contains source files for the test programs,
which are built with "make dev".