From 0ffbd21ade005803215f2292e478b65698d212d8 Mon Sep 17 00:00:00 2001 From: Jan Date: Sun, 24 Sep 2023 16:46:08 +0200 Subject: [PATCH] Add section about cloning the repository in the README --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 3c8c9aba..a64c6ebf 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,11 @@ A full list of the subcomponents can be found [here](./docs/OatComponents.md). ## Getting started -Building OAT requires git to be installed on your machine and to be in your PATH. -This project uses premake to generate project files depending on your platform. +You need to clone this repository using Git. +Do not download as a zip from Github because it will not be a git repository which is required for installing the submodules. + +Building OAT requires Git to be installed on your machine and to be in your PATH. +This project uses Premake to generate project files depending on your platform. Note: The first time setting up will clone any submodules with git so the first initialization might take a bit.