Skip to content

Commit

Permalink
docs: Inform user about use of submodules
Browse files Browse the repository at this point in the history
This change documents the use of submodules in the repository and how
the user can correctly set them up.

Fixes #2
  • Loading branch information
fabianishere committed Apr 30, 2020
1 parent 9b1aced commit 31f3b4a
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit 31f3b4a

Please sign in to comment.