From 13e2aa7f1dfcb1424f4d1ff92cf911ceece14135 Mon Sep 17 00:00:00 2001 From: Kjetil Klaussen Date: Thu, 21 Mar 2019 18:43:38 +0100 Subject: [PATCH] #852 Adding instructions to add submodules when cloning the repository --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index a72074f8f..079f2106f 100644 --- a/README.md +++ b/README.md @@ -123,6 +123,14 @@ To clone ImageSharp locally click the "Clone in Windows" button above or run the git clone https://github.com/SixLabors/ImageSharp ``` +### Submodules + +This repository contains [git submodule](https://blog.github.com/2016-02-01-working-with-submodules/). To add the submodules to the project, navigate to the repository root and type: + +``` bash +git submodule update --init --recursive +``` + ### How can you help? Please... Spread the word, contribute algorithms, submit performance improvements, unit tests, no input is too little. Make sure to read our [Contribution Guide](https://github.com/SixLabors/ImageSharp/blob/master/.github/CONTRIBUTING.md) before opening a PR.