head	1.2;
access;
symbols
	rel-7-10-4:1.2
	STABLE:1.2.0.2
	rel-7-10-2:1.2
	rel-7-10-0:1.2
	rel-7-8-4:1.2
	rel-7-8-2:1.1
	rel-7-8-0:1.1
	trimnurbs-branch:1.1.0.2
	help:1.1;
locks; strict;
comment	@# @;


1.2
date	2006.07.30.18.55.19;	author brlcad;	state Exp;
branches;
next	1.1;

1.1
date	2006.02.21.20.27.35;	author brlcad;	state Exp;
branches;
next	;


desc
@@


1.2
log
@add an introductory header that hopefully better explains the various content in the src/ directory as well as a basic summary of just what it comprises before getting into the individual content dirs
@
text
@Contained in this directory are the sources to BRL-CAD.  This
presently includes over 400+ tools and more than two dozen libraries
across more than a million lines of source code.  The contents of the
individual directories are briefly described below.
	It is part of BRL-CAD's intentional build infrastructure
design consideration to not require the installation of minor 3rd
party external codes in order for the package to compile or operate
correctly.  As part of this philosophy, the majority of BRL-CAD's
required and optional dependencies are preconfigured and bundled with
the package in the "other" directory.  For those components of BRL-CAD
that have library dependencies that are not easily bundled in a
cross-platform sustainable manner, such as linkages to commercial
libraries, said components are included in the "external" directory.

Contents
--------

adrt - Advanced Distributed Ray-Tracer, high-performance triangle ray-trace tools
anim - animation tools
archer - Archer, a geometry modeler implemented in Tcl
brlman - a 'man' tool that knows where to look for BRL-CAD manual pages
burst - tool for simulation of burst effects
bwish - BRL-CAD's version of 'tclsh' and 'wish' Tcl/Tk interpreters
canon - tool to spool/queue image data to Canon printers via MDQS
external - codes that require non-bundled external functionality
fb - tools for displaying images to and reading from a framebuffer
fbed - a framebuffer editor
fbserv - the framebuffer server
gtools - geometry processing tools (validation, transferring, comparing)
halftone - tool for producing halftoned images from B&W images
irprep - Infrared processing tools
java - Java interface code for a Java-based BRL-CAD geometry server
lgt - an interactive geometry rendering tool
libbn - the BRL-CAD numerics library
libbu - the BRL-CAD utility library
libcursor - a 2D cursor manipulation library
libdm - a 3D display manager library
libfb - a 2D framebuffer library
libfft - a fast Fourier transform library
libmultispectral - a multispectral ray-tracing optics library
liboptical - an optics library for raster image ray-tracing
liborle - an "old" run-length image encoding library
libpkg - a network package transport library
librt - the BRL-CAD ray-trace library
librtserver - the JNI interface to librt providing raytrace services to Java
libsysv - a System V compatibility library (deprecated)
libtclcad - a library for Tcl routines related to CAD
libtermio - a terminal I/O library
libwdb - the write database library, for creating BRL-CAD geometry models
mged - the Multi-device Geometry Editor, a CSG solid modeler
mk - tools for creating various common geometry objects (bolts, handles, windows, etc)
nirt - Natalie's Interactive Ray-Tracer, an interactive ray-trace tool
other - 3rd party code optionally utilized by BRL-CAD
proc-db - tools for procedurally creating geometry models
remrt - remote distributed ray-trace tools, a client and server
rt - the BRL-CAD ray-tracers, various analytic and visual ray-trace-based tools
rttherm - a thermal energy (heat) ray-tracer
sig - signal processing tools, data conversion and manipulation of raw data
tab - table processing tools, used primarily in conjunction with animation tools
tclscripts - a library of Tcl routines used by mged, rtwizard, and archer
util - various image processing and conversion utilities
vas4 - tool for driving a Lyon Lamb Video Animation System (VAS4) to record videotape
vdeck - tool for generating COM-GEOM decks from a BRL-CAD geometry file
@


1.1
log
@initial README file that describes what is in each of the various directories in here
@
text
@d1 17
d25 1
@

