Skip to content

Commit b7cf681

Browse files
hageboecksponce
authored andcommitted
Adapt README
The section about exercises needed updating after it was adapted to the advanced course.
1 parent 7605698 commit b7cf681

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -55,17 +55,19 @@ one word per line and is case-sensitive.
5555

5656
## Exercises guidelines
5757

58-
### About instructions for mentors and students
58+
### Instructions for mentors and students
5959

60-
The [cheat sheet](code/ExercisesCheatSheet_All.md) is only for mentors, with roadmap, solutions and key points to discuss.
60+
Students should start with the README in the respective exercise folders. These have the basic building instructions, give the name of the main program file, and possibly give a summary of the exercise goals and steps.
6161

62-
Readmes are for students. These host the basic building instructions, give the name of the main program file, and possibly give a summary of the exercise goals and steps.
62+
Inside the code, one gets more precise help on what should/could be done. If the code is longer and only some parts need to be touched, this is often pointed out with comments.
6363

64-
Inside the code, one gets more precise help on what should/could be done and also where (e.g. when the code is long and only one part needs to be worked on).
65-
66-
### About solutions
64+
### Solutions to exercises
6765

6866
Each exercice should provide a solution in the `solution` subdirectory. For any `<name>.cpp` exercise, the solution should be called `solution/<name>.sol.cpp`.
67+
We invite students to only consult the solution when they completed an exercise or when they are really stuck. The preferred order is:
68+
1. Work on the exercise and consult the slides
69+
2. Discuss problems and questions with the class and the mentor
70+
3. Consult the solution
6971

7072
### About building
7173

@@ -82,6 +84,11 @@ make
8284
make solution
8385
```
8486

87+
### For Mentors
88+
89+
Depending on which course is running, consult the schedule for exercise sessions in [essentials](code/ExerciseSchedule_EssentialCourse.md) or [advanced](code/ExerciseSchedule_AdvancedCourse.md).
90+
For mentors, there is a [cheat sheet](code/ExercisesCheatSheet.md) with hints towards the solutions and key points to discuss during the exercise sessions.
91+
8592
## Contributors ✨
8693

8794
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

0 commit comments

Comments
 (0)