From 7d79fbc1c07fef5848cbb517e0d0882094e4d292 Mon Sep 17 00:00:00 2001
From: Benjamin <703973+deferredreward@users.noreply.github.com>
Date: Mon, 18 Mar 2024 16:45:33 -0500
Subject: [PATCH] readme updated

---
 README.md                 | 35 ++++++++++++++++++++++++++++++++++-
 UST/ProjectUserAccess.xml | 18 ++++++++++++++++++
 2 files changed, 52 insertions(+), 1 deletion(-)
 create mode 100644 UST/ProjectUserAccess.xml

diff --git a/README.md b/README.md
index 1b32ba8..c954b7f 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,36 @@
 # en_BP_Paratext
 
-ULT with TNs as notes and TWs (a little dated as of Mar 2024) integrated. UST. All setup for Paratext use.
\ No newline at end of file
+ULT with TNs as notes and TWs (TWs are a little dated as of Mar 2024) integrated. UST. All setup for Paratext use.
+Last updated 3/18/2024
+
+## How to use this:
+Download the repo as a zip, unzip into your `My Paratext 9 Projects` directory. You should have a ULT and UST directory now. Restart Paratext. Open ULT/UST from `Projects`. Translation notes show as Paratext notes. 
+
+In order to allow users to comment on notes and resolve completed ones, admins may want to add the following to the `ProjectUserAccess.xml` files:
+  <User UserName="YOUR_USER'S_NAME_AS_IN_OTHER_PARATEXT_PROJECTS" FirstUser="false" UnregisteredUser="true">
+    <Role>Consultant</Role>
+    <AllBooks>true</AllBooks>
+    <Books />
+    <Permissions>
+      <Permission Type="TermsList" Granted="false" />
+      <Permission Type="Renderings" Granted="false" />
+      <Permission Type="Spellings" Granted="false" />
+      <Permission Type="Passages" Granted="false" />
+      <Permission Type="Progress" Granted="false" />
+    </Permissions>
+    <AutomaticBooks />
+    <AutomaticPermissions />
+  </User>
+Set "UnregisteredUser" to true or false depending on your user's Paratext status.
+
+
+### How to make/update this:
+- Download and unzip ULT & UST from DCS preview page. 
+    - Replace all `{` with `\add ` and  `}` with `\add*` in these ULT/UST.
+    - Import these books over ULT/UST project (requires edit permissions).
+
+- Clone ULT, UST, TN, TA, Hebrew OT, Greek NT repos from door43.    
+    - Use this script to generate the notes.xml file, place in ULT directory. You will need proskomma and other things installed via npm. Modify directory paths to your own. https://github.com/deferredreward/unfoldingword-scripts-to-work-with-data/blob/main/tsv7%20to%20paratext.js
+
+- In that same github repo there's a script that can convert TWs into the xml files needed for Biblical terms lists in Paratext. https://github.com/deferredreward/unfoldingword-scripts-to-work-with-data/blob/main/tws%20to%20paratext%20biblical%20terms.py
+    - You'll need to clone TW and TWL probably, I haven't touched this in a while.
diff --git a/UST/ProjectUserAccess.xml b/UST/ProjectUserAccess.xml
new file mode 100644
index 0000000..125a117
--- /dev/null
+++ b/UST/ProjectUserAccess.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+<ProjectUserAccess PeerSharing="true">
+
+  <User UserName="unfoldingWord" FirstUser="true" UnregisteredUser="true">
+    <Role>Administrator</Role>
+    <AllBooks>true</AllBooks>
+    <Books />
+    <Permissions>
+      <Permission Type="TermsList" Granted="true" />
+      <Permission Type="Renderings" Granted="true" />
+      <Permission Type="Spellings" Granted="true" />
+      <Permission Type="Passages" Granted="true" />
+      <Permission Type="Progress" Granted="true" />
+    </Permissions>
+    <AutomaticBooks />
+    <AutomaticPermissions />
+  </User>
+</ProjectUserAccess>
\ No newline at end of file