Changes between Initial Version and Version 1 of dev/runbook


Ignore:
Timestamp:
Jun 24, 2020 8:56:40 PM (4 years ago)
Author:
jonathan
Comment:

Page introduction, details about initializing Git sub-modules

Legend:

Unmodified
Added
Removed
Modified
  • dev/runbook

    v1 v1  
     1= Developer Runbook (Quick Start and Tips) =
     2This wiki page is intended for mod developers that work with the source code.  Assuming you are using ''IntelliJ IDEA'', this documents some additional necessary steps to take above and beyond simply cloning the Git repository and importing it into IntelliJ
     3
     4== Sub-module Initialization ==
     5The repository uses a sub-module ''Hydrazine Path Engine'' which is not hosted by our repository but is hosted for the public on !GitHub [https://github.com/MadMartian/hydrazine-path-finding here].  In order for your local Git clone to be aware of this run the following command from the repository root directory the first time you clone the repository or if you are updating to [6cf515ed3c0aa43abad5bf4e0b6a7aa6e05db650] or later:
     6
     7{{{#!sh
     8git submodule update --init --recursive --remote
     9}}}
     10
     11This will pull the sub-modules from external sources updated to their respective tips.