Add note on cloning due to submodules

nucleus-js · Aug 6, 2016 · bdf9c5a · bdf9c5a
1 parent e21fa2e
commit bdf9c5a
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -4,6 +4,8 @@
 Nucleus is a specification for a minimal JS runtime that makes it fun to create
 your own platforms.
 
+**Note**: This repo also uses _[git submodules](https://chrisjean.com/git-submodules-adding-using-removing-and-updating/)_ to manage it's dependencies. As such, cloning this repo must be done with `git clone --depth=1 ...`.
+
 ## Up and Running
 
 To get up and running with Nucleus implementations, check out the [implementations]