aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Garlick <pgarlick@tourbillion-technology.com>2017-02-20 17:05:23 +0000
committerPaul Garlick <pgarlick@tourbillion-technology.com>2017-02-20 17:05:23 +0000
commitfbb55def5bb68922fdedd351c9a9acfc509c475a (patch)
treef8014f7a279c1b6d0d16237156fd69368f40f9e0
parentb98df35e5846b44ce25f1824d83fac70d5b6ad6c (diff)
downloadtweed-fbb55def5bb68922fdedd351c9a9acfc509c475a.tar.gz
add directory stucture diagram to README file
-rw-r--r--README.md29
1 files changed, 27 insertions, 2 deletions
diff --git a/README.md b/README.md
index a7f9b74..5607cff 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,5 @@
# Tweed.README
-Copyright © 2016 Paul Garlick <[pgarlick@tourbillion-technology.com](mailto:pgarlick@tourbillion-technology.com)>
+Copyright © 2016, 2017 Paul Garlick <[pgarlick@tourbillion-technology.com](mailto:pgarlick@tourbillion-technology.com)>
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
@@ -82,6 +82,31 @@ following applications:
4. [FEniCS](https://fenicsproject.org/)---numerical simulation
+The directory structure for a typical *TWEED* installation is shown in the
+diagram below. The configuration files are stored in the *tweed* directory,
+located in the user's home directory. The three package managers use the
+directories $HOME/.hashdist, /GNU and /nix respectively to store the
+application files. GNU Guix uses sub-directories in /var to store log files
+and database files.
+
+```
+ / (root)
+ ├── OS
+ ├── var
+ │ ├── log
+ │ │ └── guix
+ │ └── guix
+ │
+ ├── $HOME
+ │ ├── .hashdist
+ │ └── tweed
+ │ ├── hashdist
+ │ └── hashstack
+ │
+ ├── gnu
+ └── nix
+```
+
A user may install a subset of the *TWEED* packages. It is also possible for
the user to extend the list of packages, beyond the group offered by *TWEED*.
For details of the installation procedure, please see the file INSTALL.
@@ -99,5 +124,5 @@ applications provided by the different package managers changes.
Paul Garlick
-November 2016
+February 2017