diff --git a/README.md b/README.md index 4f58322..0d84089 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,11 @@ Clone this repo with `git clone --recurse-submodules https://patience.nearmisses When pulling, include the submodule with `git pull --recurse-submodules` +## Updating submodule upstream +To update the embedded submodule to the latest available version: +1. Run `git submodule init` once to initialise it +2. Run `git submodule update --remote` to update it +3. Commit as usual (e.g. `git commit -m "Updated submodule"`) + +## Exporting To create a release, run [export-pack.sh](export-pack.sh). It will be generated in [release/Tinker's tinkering.mrpack](Tinker's%20tinkering.mrpack)