From fe30e09d161e6e3196c295c34d15cb64a624d058 Mon Sep 17 00:00:00 2001
From: tildearrow <tildearrow@protonmail.com>
Date: Fri, 28 Jan 2022 22:23:08 -0500
Subject: [PATCH] update readme to clarify build process

---
 README.md | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c7fbb8d1..73174122 100644
--- a/README.md
+++ b/README.md
@@ -50,6 +50,8 @@ check out the [documentation](papers/doc/README.md). it's mostly incomplete, but
 
 # developer info
 
+**NOTE: do not download the project's source as a .zip or .tar.gz as these do not include the project's submodules which are necessary to proceed with building.**
+
 ## dependencies
 
 - CMake
@@ -59,9 +61,20 @@ check out the [documentation](papers/doc/README.md). it's mostly incomplete, but
 
 SDL2 and zlib are included as submodules.
 
+## getting the source
+
+type the following on a terminal/console: (make sure Git is installed)
+
+```
+git clone --recursive https://github.com/tildearrow/furnace.git
+cd furnace
+```
+
+(the `--recursive` parameter ensures submodules are fetched as well)
+
 ## compilation
 
-your typical CMake project. clone (including submodules) and:
+your typical CMake project.
 
 ### Windows using MSVC