[brlcad-commits] CVS: brlcad/src README,1.1,1.2

[Sean M. <br...@us...>]

Update of /cvsroot/brlcad/brlcad/src
In directory sc8-pr-cvs3.sourceforge.net:/tmp/cvs-serv12791/src

Modified Files:
	README 
Log Message:
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

Index: README
===================================================================
RCS file: /cvsroot/brlcad/brlcad/src/README,v
retrieving revision 1.1
retrieving revision 1.2
diff -w -u -r1.1 -r1.2
--- README	21 Feb 2006 20:27:35 -0000	1.1
+++ README	30 Jul 2006 18:55:19 -0000	1.2
@@ -1,3 +1,20 @@
+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
@@ -5,6 +22,7 @@
 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