diff --git a/README.txt b/README.txt new file mode 100755 index 0000000..6e3677f --- /dev/null +++ b/README.txt @@ -0,0 +1,33 @@ +SETUP + +Required environment variables: + +TEACHING_SHARED +This variable specifies the path to the top level of the teaching shared +directory hierarchy, whereever you happen to have put it (e.g., on my +machine this is set to "/Users/nstanger/Documents/Teaching/Shared"). + +ALL_PAPERS_ROOT +This variable specifies the path to the top level directory for all +papers taught, i.e., the directory that contains the individual paper +directory hierarchies. This assumes that you have all your current paper +directories contained within a single hierarchy. If you don't, you're in +trouble :) For example, on my machine this is set to +"/Users/nstanger/Documents/Teaching/2005" (which contains directories +INFO212, INFO321, ...). + +HANDBOOK_INSTALL_ROOT +This variable specifies the path to the top level directory on the web +server, under which the files for this paper will be installed (that is, +the directory that contains the individual paper directory hierarchies). +Under Windows this would typically point to \\INFO-NTS-12\DBCourses$ +(but this may require munging depending on how UNC paths are dealt +with). On my machine this is set to "/Volumes/DBCOURSES$", because this +is where the share gets mounted. + +XSLT +This variable specifies your preferred XSLT processor. Currently the +valid options are "saxon" for SAXON 6.5.x, "xalan-c" for the C++ +implementation of Xalan and "xalan-j" for the Java implementation of +Xalan (weirdly, the latter two have different command line options). For +example, on my machine this is set to "saxon".