From ec48320b4d827bfb21d20ca49df1765ef14159e6 Mon Sep 17 00:00:00 2001
From: Adam Thorn <alt36@cam.ac.uk>
Date: Mon, 9 Mar 2020 09:40:41 +0000
Subject: [PATCH] Update README.md to reflect current reality

* Put UNC paths inside `code` block so the slashes render properly
* Move institute codes to a wiki page
* update repository layout in light of tweaks made by alt36 and cm214 last week
---
 README.md | 19 ++++++++++---------
 1 file changed, 10 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 5487b8f0..4945dd1b 100644
--- a/README.md
+++ b/README.md
@@ -29,18 +29,19 @@ Note: in general, the expectation is that environment variables with names start
 
 Share location
 ==============
-* set WPKGSOFTWARE=\\ifs.ch.private.cam.ac.uk\deploy\software
-* set WPKGSHAREBASE=\\ifs.ch.private.cam.ac.uk\deploy
+* `set WPKGSOFTWARE=\\ifs.ch.private.cam.ac.uk\deploy\software`
+* `set WPKGSHAREBASE=\\ifs.ch.private.cam.ac.uk\deploy`
 
 Institute codes
-==============
-1. chemistry  
-Department of Chemistry
-2. maths  
-Faculty of Mathematics
+===============
+See https://gitlab.developers.cam.ac.uk/ch/co/ucam_wpkg/-/wikis/Institude-codes
 
 Repository layout
 ================
 
-\packages - directory with multiple xml files, each of corresponds to an individual WPKG package definition
-\scripts - example scripts, e.g. wrappers around wpkg.js which map drives and set environment variables
+* packages: directory with multiple xml files, each of corresponds to an individual WPKG package definition
+* packages\wpkg\tools: scripts which are called from wpkg definition
+* miscscripts: example scripts, e.g. wrappers around wpkg.js which map drives and set environment variables
+
+* common-config: config files that are used in a wpkg for all institutions
+* %WPKGINSTITUTION%-config: config files specific to a particlar institution.
-- 
GitLab