diff --git a/README.md b/README.md index 98c5fa4..8ab1875 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,10 @@ Everything should just work beyond that point (fingers crossed! ☺), barring any backwards incompatible changes to classes or the like. -To update: +**IMPORTANT!!** If you change any of the submodules, make sure that you commit and push the submodule *first*, then commit and push *this* repository to resynchronise the submodule pointer. Otherwise you’ll end up with a detached HEAD in the submodule and things can get very messy! +Assuming everything is properly pushed, then updating is just a matter of: + + % git pull % git submodule update % make install - -Note that if you commit in any of the submodules, you’ll need to do a `git submodule update` in the parent repository to resynchronise the submodule pointer.