diff --git a/README.md b/README.md index 94817af7b4fc5c22c2790d890685fdc0c99a5ab3..13ec64c247cb74f3b9220c375aafd17ed1c607da 100644 --- a/README.md +++ b/README.md @@ -13,11 +13,9 @@ A rendered HTML version of the master guide can be found at https://zhukov1.page ## Branches -Development happens on the `master` branch. -An instance branch is created for every time the course is tought, following the naming scheme `instances/<YYYY>_<MM>` where `<YYYY>` and `<MM>` are the year and month in the Gregorian calendar the course starts in, e.g. `instances/2021_05`. +Development happens on the `main` branch. +An instance branch is created for every time the course is tought, following the naming scheme `instances/<YYYY>_<MM>` where `<YYYY>` and `<MM>` are the year and month in the Gregorian calendar the course starts in, e.g. `instances/2024_11`. Instance branches start by filling in place holders for things that change from one iteration to another, e.g. compute project names and the course date. -If there is activity on the `master` branch, the instance branch is rebased to sit on top of it, until the course starts. +If there is activity on the `main` branch, the instance branch is rebased to sit on top of it, until the course starts. Changes that are made during the course go on the instance branch. -If they are to be included in the material for subsequent instances, they are cherry-picked into `master` after the course has ended. - -Rendered HTML for instance branches is deployed to a subdirectory `<YYYY>_<MM>`, e.g. for [instances/2022_05](https://zhukov1.pages.jsc.fz-juelich.de/intro2sc-handson/2022_05). \ No newline at end of file +If they are to be included in the material for subsequent instances, they are cherry-picked into `main` after the course has ended. \ No newline at end of file