Changes between Version 5 and Version 6 of dev/runbook

Timestamp:

Sep 7, 2020 4:15:16 PM (4 years ago)

Author:

jonathan

Comment:

Initialize a specific sub-module

dev/runbook

@@ -13 +13 @@
 **NOTE**: If this fails it's likely because a skeletal sub-module directory already exists (i.e. `./hydrazine-path-engine/`), check to make sure you do not have any local changes in this folder and then delete this folder.  Then run the command again.
 
+=== Initialize Specific Sub-Module ===
+To initialize a specific sub-module instead of all of them (e.g. you have initialized ''Hydrazine'' but not ''Data Structures'') run the following commands:
+
+{{{#!sh
+git submodule init -- < sub-module name >
+git submodule update -- < sub-module name >
+}}}
+
+Where `sub-module name` is the name and path of the sub-module to update relative to the root directory of the project (e.g. ''data-structures'')
+
 == 2. Setup Decompiled Workspace ==
 The first thing to do after cloning the Git repository is to run the gradle task `setupDecompWorkspace`.  This processes the ''Minecraft'' source making some necessary changes to the binary code that are expected by our source.  The most straightforward way to do this is from inside IntelliJ, but you can also do it from the command line as follows from the root directory of the project: