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. diff --git a/documentation/developers/dependencies/create_dependency_charts.sh b/documentation/developers/dependencies/create_dependency_charts.sh new file mode 100755 index 0000000..9b88c65 --- /dev/null +++ b/documentation/developers/dependencies/create_dependency_charts.sh @@ -0,0 +1,16 @@ +#!/bin/bash + +function generate_chart { + debtree --no-recommends --max-depth=2 $1 | dot -Tpdf -o $1-dependencies.pdf +} + +generate_chart libtdekrb-trinity +generate_chart libtqtrla +generate_chart remote-laboratory-client-trinity +generate_chart ulab-adminsysctlserver +generate_chart ulab-adminusermgmtserver +generate_chart ulab-authserver +generate_chart ulab-fpgaprogserver +generate_chart ulab-fpgaserver +generate_chart ulab-gpibserver +generate_chart ulab-sensormonserver diff --git a/documentation/developers/dependencies/libtdekrb-trinity-dependencies.pdf b/documentation/developers/dependencies/libtdekrb-trinity-dependencies.pdf new file mode 100644 index 0000000..fd35842 Binary files /dev/null and b/documentation/developers/dependencies/libtdekrb-trinity-dependencies.pdf differ diff --git a/documentation/developers/dependencies/libtqtrla-dependencies.pdf b/documentation/developers/dependencies/libtqtrla-dependencies.pdf new file mode 100644 index 0000000..db9d2c7 Binary files /dev/null and b/documentation/developers/dependencies/libtqtrla-dependencies.pdf differ diff --git a/documentation/developers/dependencies/remote-laboratory-client-trinity-dependencies.pdf b/documentation/developers/dependencies/remote-laboratory-client-trinity-dependencies.pdf new file mode 100644 index 0000000..a3cc07c Binary files /dev/null and b/documentation/developers/dependencies/remote-laboratory-client-trinity-dependencies.pdf differ diff --git a/documentation/developers/dependencies/ulab-adminsysctlserver-dependencies.pdf b/documentation/developers/dependencies/ulab-adminsysctlserver-dependencies.pdf new file mode 100644 index 0000000..52da25d Binary files /dev/null and b/documentation/developers/dependencies/ulab-adminsysctlserver-dependencies.pdf differ diff --git a/documentation/developers/dependencies/ulab-adminusermgmtserver-dependencies.pdf b/documentation/developers/dependencies/ulab-adminusermgmtserver-dependencies.pdf new file mode 100644 index 0000000..a3f8481 Binary files /dev/null and b/documentation/developers/dependencies/ulab-adminusermgmtserver-dependencies.pdf differ diff --git a/documentation/developers/dependencies/ulab-authserver-dependencies.pdf b/documentation/developers/dependencies/ulab-authserver-dependencies.pdf new file mode 100644 index 0000000..e068d7d Binary files /dev/null and b/documentation/developers/dependencies/ulab-authserver-dependencies.pdf differ diff --git a/documentation/developers/dependencies/ulab-fpgaprogserver-dependencies.pdf b/documentation/developers/dependencies/ulab-fpgaprogserver-dependencies.pdf new file mode 100644 index 0000000..4caaaa9 Binary files /dev/null and b/documentation/developers/dependencies/ulab-fpgaprogserver-dependencies.pdf differ diff --git a/documentation/developers/dependencies/ulab-fpgaserver-dependencies.pdf b/documentation/developers/dependencies/ulab-fpgaserver-dependencies.pdf new file mode 100644 index 0000000..d594e6a Binary files /dev/null and b/documentation/developers/dependencies/ulab-fpgaserver-dependencies.pdf differ diff --git a/documentation/developers/dependencies/ulab-gpibserver-dependencies.pdf b/documentation/developers/dependencies/ulab-gpibserver-dependencies.pdf new file mode 100644 index 0000000..e095761 Binary files /dev/null and b/documentation/developers/dependencies/ulab-gpibserver-dependencies.pdf differ diff --git a/documentation/developers/dependencies/ulab-sensormonserver-dependencies.pdf b/documentation/developers/dependencies/ulab-sensormonserver-dependencies.pdf new file mode 100644 index 0000000..9806eed Binary files /dev/null and b/documentation/developers/dependencies/ulab-sensormonserver-dependencies.pdf differ diff --git a/protocol.txt b/documentation/developers/protocol/rfc.txt similarity index 100% rename from protocol.txt rename to documentation/developers/protocol/rfc.txt