docs: mention submodules

This commit is contained in:
Alessandro Pezzè 2020-07-10 15:05:53 +02:00
parent dd9680ecf2
commit 14e9b191c3

View file

@ -40,7 +40,7 @@ Once you've signed up visit [PokéAPI on Slack](https://pokeapi.slack.com)
## Setup [![pyVersion37](https://img.shields.io/badge/python-3.7-blue.svg)](https://www.python.org/download/releases/3.7/)
- Download this source code into a working directory.
- Download this source code into a working directory, be sure to use the flag `--recurse-submodules` to clone also our submodules.
- Install the requirements using pip:
@ -151,7 +151,7 @@ To contribute to this repository:
- Download the forked project using git clone:
```sh
git clone git@github.com:<YOUR_USERNAME>/pokeapi.git
git clone --recurse-submodules git@github.com:<YOUR_USERNAME>/pokeapi.git
```
- Create a new branch with a descriptive name: