diff --git a/README.md b/README.md index 89ad5bb..ec89b52 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -# ClassRepoTemplate +# Class Repository Template This is a repo that serves as a template for a repository for a particular -instance of a class for th UWPCE Python Certificate. +instance of a class for the UWPCE Python Certificate. A copy of this repo will be made for each class, so that it can be used by the class to share information and for students to submit their work. -## Structure of the repo +## Structure of the Repo The class repo has three top level directories: @@ -13,6 +13,6 @@ The class repo has three top level directories: `solutions`: Used to post solutions to the exercises -`students`: Used for the students to submit their work. Each student will create a dir in the studetns dir in which to put their work. +`students`: Used for the students to submit their work. Each student will create a directory in the students directory in which to put their work. diff --git a/solutions/00-README.md b/solutions/00-README.md index eaee27b..a9e8dd8 100644 --- a/solutions/00-README.md +++ b/solutions/00-README.md @@ -1 +1,6 @@ -This dir will hold solutions to the exercises as they become available. +# Solutions +Place solutions in this directory as they become available. + +Remember to document your solutions, preferably mentioning where +students might get tripped up. None of the teachers, and none of the students, +want to debug *your* code. diff --git a/students/00-README.md b/students/00-README.md index 46a4586..12eab12 100644 --- a/students/00-README.md +++ b/students/00-README.md @@ -1,3 +1,10 @@ -Students: Please create a directory named after you, -with a readme in it, in this directory. +# Welcome, Students! +When you join the course, please do the following: +1. Create a directory named after you. +2. Create a README for your directory. + * Feel free to personalize it a bit! + * Share some things about what makes you you. + * Tell us what you want to get out of this course. + * Protip: Never make a project without a README. What if Two-Years-Older-*You* + forgets what the project was about? diff --git a/students/Example_Student/00-README.md b/students/example_student/00-README.md similarity index 100% rename from students/Example_Student/00-README.md rename to students/example_student/00-README.md diff --git a/students/Example_Student/name_of_exercise/demo_file.py b/students/example_student/name_of_exercise/demo_file.py similarity index 100% rename from students/Example_Student/name_of_exercise/demo_file.py rename to students/example_student/name_of_exercise/demo_file.py