diff --git a/README.md b/README.md index c46bc98d070bccba98c9c25c0334b052421a1ced..ad5e3fa24b7a5727877fd6788635ca0935ffb655 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. + + +