From 697ae7b279afacb23e76a3b69b7da45065d98b39 Mon Sep 17 00:00:00 2001
From: Ilya Zhukov <i.zhukov@fz-juelich.de>
Date: Mon, 7 Oct 2024 17:10:54 +0200
Subject: [PATCH] Update development instructions.

---
 README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 334d9dd3..94817af7 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,23 @@
+# JSC Hands On
+
+This project is intended to document all steps a user has to go through in order to run codes on our supercomputers. It is complemented by a theoretical part consisting of presentations for various topics.
+
+A rendered HTML version of the master guide can be found at https://zhukov1.pages.jsc.fz-juelich.de/intro2sc-handson/
+
+## How to modify 
+
 * To make changes to the main page such as altering the description or adding links, you'll need to modify the **```docusaurus.config.ts```** file.
 * If you wish to edit the text below the pictures or add new ones, you'll find the relevant code in the **```src/components/HomepageFeatures/index.tsx```** file.
 * For adjustments to the hands-on section, navigate to the **```docs```** directory.
-* To make changes to the blog section, navigate to the **```blog```** directory.
\ No newline at end of file
+* To make changes to the blog section, navigate to the **```blog```** directory.
+
+## 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`.
+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.
+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
-- 
GitLab