Skip to content

Repository Layout

Ben Cumming edited this page Jul 13, 2016 · 5 revisions

Please read this before adding anything to the repository! And please don't hesitate asking Ben if you have any questions about how to organize your contribution to the repository.

Topics

The topics (OpenMP, MPI, CUDA, etc) are to be put in their own path in the topics path. Practicals, solutions and lecture slides can be organized as you wish in side the path.

  1. it is best to add the slides "at the last minute" before you start teaching, to minimize the chances that the repository will get bloated by updating pdf files.
  2. keep the solutions in a separate path to the practicals.
  3. avoid updating source code in practicals unless absolutely necessary once you have started teaching.

Points 2. and 3. above minimize the risk of conflicts when students update their repositories.

Here is an example layout for the OpenMP topic:

topics/openmp
|_ slides
|_ practicals
|  |_ cxx
|  |_ fortran
|
|_ solutions
   |_ cxx
   |_ fortran

miniapp

The different versions of the minapp are in the miniapp path. There is one path in miniapp for each version. Slides can go in the version's path, and then have a path for the source and solutions. Again, see the openmp version for an example.

Clone this wiki locally