diff --git a/README.md b/README.md index b5b17cc..a2f14d8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -Various LaTeX classes. Note that some of this exists as independent LaTeX repostiories (e.g., ouexam, beamerthemes). These are included as submodules. +Various LaTeX classes. Note that some of this exists as independent LaTeX repostiories (e.g., ouexam, beamerthemes). These are included as git subtrees. To install, ensure that `$TEXMFHOME` is set to your personal texmf tree (e.g., `~/.texmf`), then: @@ -8,10 +8,12 @@ Everything should just work beyond that point (fingers crossed! ☺), barring any backwards incompatible changes to classes or the like. -**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 may end up with a detached HEAD in the submodule and things can get very messy! +**IMPORTANT!!** Several of the subdirectories are git subtrees pointing to independent repositories. While you can edit things in the subtree and push them back to the upstream repository, it’s probably better to edit them in a separate clone of the original repository. -Assuming everything is properly pushed, then updating on other clients is just a matter of: +To pull upstream changes to the subtrees (e.g., for ouexam): - % cd submodule; git pull - % cd ..; git pull - % make install + % git subtree pull --prefix=ouexam --squash ouexam master + +To push changes to the upstream repository (see note above): + + % git subtree push --prefix=ouexam --squash ouexam master