chore: add README.md

.devcontainer.json

@@ -3,5 +3,13 @@
 	"image": "mcr.microsoft.com/devcontainers/typescript-node:1-20-bookworm",
 	"containerEnv": {
 		"ASTRO_TELEMETRY_DISABLED": "1"
+	},
+	"customizations": {
+		"vscode": {
+			"extensions": [
+				"astro-build.astro-vscode",
+				"unifiedjs.vscode-mdx"
+			]
+		}
 	}
 }

README.md

@@ -1,2 +1,20 @@
 # Course template
 
+This template consists of documentation and slides for courses:
+ - Slides: https://github.com/openscript-ch/slidev-theme
+ - Documentation: https://github.com/openscript-ch/astro-course-theme
+
+## Usage
+
+1. Make sure you have [Docker](https://docs.docker.com/get-docker/) up and running
+1. Get [Visual Studio Code](https://code.visualstudio.com/) with [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) ready
+1. Open the project inside a Dev Container
+1. Install dependencies with `pnpm install`
+1. Start develop environment with `pnpm dev`
+
+## Update from template
+
+1. Add upstream with `git remote add upstream git@github.com:openscript-ch/course-template.git`
+1. Fetch upstream with `git fetch upstream`
+1. Merge upstream with `git merge upstream/main`
+