added readme.md

README.md

@@ -0,0 +1,20 @@
+# PR3 Code Repository
+
+This repository contains all code of the PR3 lecture. This includes assignments. Solutions and code produced during the lecture is added incrementally during the semester.
+
+## Usage
+
+The code for each programming language is located in a dedicated subfolder. The individual development environment is defined by a [Development Container](https://containers.dev/) which ensures a uniform easy to set up coding experience on all platforms (Windows/MacOS/Linux). The following tools shall be available on the developer's machine:
+
+- A [container runtime](https://en.wikipedia.org/wiki/OS-level_virtualization) such as [docker](https://www.docker.com/) or [podman](https://podman.io/). Windows users should install [Windows Subsystem for Linux (WSL)](https://learn.microsoft.com/en-us/windows/wsl/) beforehand.
+
+- [Visual Studio Code](https://code.visualstudio.com/) along with the [Dev Containers](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) extension.
+
+Follow these steps to get started:
+
+1. Clone this repository into a local folder of your choice. Use a WSL folder on Windows.
+2. Navigate to the subfolder of the desired programming language (e.g. `cd pr3-xyz/go`). 
+3. Open Visual Studio Code in that folder by executing `code .`
+4. Click on *Reopen in Container* in the popup that appears on the bottom right corner: ![](vscode-devcontainer-popup.png)
+
+This will open the folder in the dedicated *Development Container* that contains all required tools. Furthermore, programming language specific Visual Studio Code extensions are automatically installed inside the *Development Container* without affecting the host system.