From 2f7e5b42add5d8f60cc4c621f930c360766f7656 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tom=20K=C3=B6nig?= <hi@tomknig.de>
Date: Thu, 28 Sep 2023 12:06:23 +0200
Subject: [PATCH] Document usage of git submodules

Some examples use git submodules, which was previously undocumented. This commit adds the documentation necessary for a successful local setup.
---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index 7e26d81..12719c7 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,15 @@
 
 This repository contains code examples for [go-perun](https://github.com/hyperledger-labs/go-perun).
 
+## Setup
+
+Some of the examples presented in this repository make use of [git submodules](https://git-scm.com/book/de/v2/Git-Tools-Submodule). You will need to pull the submodules in order to use the respective examples:
+
+``` shell
+git submodule init
+git submodule update
+```
+
 ## License
 
 The source code in this repository is made available under the Apache License, Version 2.0.