From d24658f211b1f30953c2e093a889058f2e01ce02 Mon Sep 17 00:00:00 2001
From: Arne Schwabe <arne@rfc2549.org>
Date: Tue, 24 Sep 2024 13:14:59 +0200
Subject: [PATCH] Explicitly note that the sub module has to be checked out to
 build lwipovpn

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 41e1ee9..ac7c0fc 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,19 @@ Limitations
  - LWIP does not have a netmask for IPv6 addresses. Addresses are always assumed to be /64
  - Routes are ignored and lwipovpn assumes everything to be reachable via OpenVPN
 
+
+Git checkout
+------------
+Be sure that lwipovpn has been checked with submodule recursion enabled like this:
+
+    git clone --recursive https://github.com/openvpn/lwipovpn
+
+or by enabling them in already checkout clone by using the git submodule commands:
+   
+    cd lwipovpn
+    git submodule init
+    git submodule update
+
 Building
 --------
 This project uses the CMake build system.