From 31f3b4afb82fd432c879e4a69216c3c7ed2007de Mon Sep 17 00:00:00 2001 From: Fabian Mastenbroek Date: Thu, 30 Apr 2020 19:40:43 +0200 Subject: [PATCH] docs: Inform user about use of submodules This change documents the use of submodules in the repository and how the user can correctly set them up. Fixes #2 --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1da5b51..814d3ea 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ Flappy Bird for UEFI written in x86 Assembly. ## Getting the source Download the source code by running the following code in your command prompt: ```sh -$ git clone https://github.com/fabianishere/boot2flappy.git +$ git clone https://github.com/fabianishere/boot2flappy.git --recursive ``` or simply [grab](https://github.com/fabianishere/boot2flappy/archive/master.zip) a copy of the source code as a Zip file. @@ -18,6 +18,12 @@ We provide two ways for building the project: manually on your local system or in a container using Docker. If installing the required dependencies is not trivial or unwanted, we suggest building the project with [Docker](#docker). +Make sure you have also downloaded the `deps/gnu-efi` submodule, which may be +done via: +```shell +$ git submodule update --init +``` + ### Manual Create the build directory. ```sh