From 60439ed91a4ddf30b34d6f042c3fec5a1d881bfd Mon Sep 17 00:00:00 2001
From: Jennifer Mankoff <jmankoff@cs.washington.edu>
Date: Tue, 11 Aug 2020 13:24:37 -0700
Subject: [PATCH] Update README.md to explain how to customize things

---
 README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c46bc98d..ad5e3fa2 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,20 @@
-This is the core / base for a set of accessible class websites. A good example (which this was based on) is [cse340](https://courses.cs.washington.edu/courses/cse340/)
\ No newline at end of file
+This is the core / base for a set of accessible class websites. A good example (which this was based on) is [cse340](https://courses.cs.washington.edu/courses/cse340/)
+
+# How to use
+To use this website, the following steps are necessary:
+
+1. Fork the website, so you can customize it
+2. Update the folowing variables and files:
+   * in .gitlab-ci.yml 
+        ```variables:
+            quarter: eg21wi
+            course: egcse340
+          refs:
+            - egCSE340-WI21```
+3. If at UW, 
+    * Create a directory in /courses/[your class] for this quarter
+    * ask CSE support to enable your repo for the courseweb runner
+    * Make sure to tell them which class this is for so they can set it up properly.
+
+
+
-- 
GitLab