From cc84fb1c93a9efe713079160380fce46bd5cfead Mon Sep 17 00:00:00 2001
From: Franck Royer <franck@royer.one>
Date: Mon, 15 Mar 2021 18:04:17 +1100
Subject: [PATCH] Add explanations around nim-waku setup

---
 .github/workflows/ci.yml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 2dbd310c2d..cfb29139db 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -15,12 +15,16 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Init submodules
+        # This is done as part of pretest but as we are caching the nim binary
+        # which is inside the submodule, better initialising them before
+        # recovering the binary.
         run: git submodule update --init --recursive
 
       - name: Cache nim-waku binary
         uses: actions/cache@v2
         with:
           path: ./nim-waku/build/wakunode2
+          # The nim-waku version is set by the .gitmodules file as it is a submodule
           key: nim-waku-build-v1-${{ hashFiles('.gitmodules') }}
 
       - name: Install bufbuild