Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
armandofox authored Jun 7, 2023
1 parent 5cf7ef0 commit 40a9628
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@
If you're new, please use [this repo's wiki](https://github.com/ace-lab/pl-ucb-csxxx/wiki)
to get started!

# Using this repo as a template to make a new course?
# Did you just have a course created for you?

If you are using this repo as a template to make your own course
(highly recommended), your course repo's name should be `pl-SSS-CCC`,
If so, this repo was used as a template, and your course repo's name should be `pl-SSS-CCC`,
where `SSS` is your project
institution name (`ucb`, `csulb`, `ecc`) and `CCC` is the lowercase course
number at your institution (eg `pl-ucb-cs169a`, `pl-ecc-csci8`, etc).
Expand All @@ -18,7 +17,7 @@ repo will likely contain sensitive content such as exam questions. Be
careful who has access. **All access to PL repos is by teams**, not
by adding individuals, to keep access control manageable.

* Delete the `elements` subdirectory, unless you specifically want to use
* Delete (meaning `git rm`) the `elements` subdirectory, unless you specifically want to use
the custom elements in here (see below for some documentation)
* Delete the contents of `serverFilesCourse` and `clientFilesCourse`
* Delete the contents of `courseInstances` (you'll add your own
Expand All @@ -28,6 +27,8 @@ your course's questions
* Immediately update this `README.md` and `infoCourse.json` to
reflect the info for your course, including inserting a valid UUID for
the course. You can run `uuidgen` at a shell prompt to make one.
**Important.** Just about every type of thing in PL -- course, question, element, etc. -- has a UUID (Universally Unique ID). You can generate one by typing `uuidgen` at a terminal window or by using the [UUID generator](https://www.uuidgenerator.net). For safety, in the template repo all UUID values have been set to "9999...". **In your new repo, immediately `git rm` any files you do not need, and in the files that remain, replace every UUID with a fresh one.**


**Note:** Although it has become customary to name the primary Git
branch `main` rather than `master`, **do not do so for PL repos** as
Expand Down

0 comments on commit 40a9628

Please sign in to comment.