Add initial README file and initial dependency charts

1 files changed, 12 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..65c5bc7
--- /dev/null
+++ b/README
@@ -0,0 +1,12 @@
+This is the source repository for the hardware access portion of the uLab remote laboratory system.
+
+The terminal services components are hosted in a separate GIT repository, available from the uLab project's home page at http://ulab.trinitydesktop.org
+
+This repository is a hierarchical tree, separating the main components into several related groups.  The main groups are:
+attic:		Old files of any type, provided for historical reasons.  These files are not required to build or use the uLab system, but may be of interest to academics who wish to know more about the origins of the uLab system.
+clients:	uLab clients and client parts for any supported operating systems.  Each client part is matched with a server daemon in the "servers" top level directory.
+database:	Database structure descriptors, which can be used to create the database(s) utilized by the uLab servers.
+documentation:	Various files providing developer-facing documentation for the uLab system internals.  User-facing documentation also included in a subdirectory of this directory.
+fpga:		FPGA-specific files, utilities, and programming software.  This includes the hardware debug module required for FPGA viewer operation, and the various software components utilized by the FPGA Programmer daemon.
+lib:		Libraries providing core uLab functionality.  These libraries are utilized by most uLab software, including both servers and clients.
+servers:	uLab server daemons for any supported operating systems.  Each server daemon is matched with a client part in the "clients" top level directory.