diff --git a/README.md b/README.md index 595488c..5b816ab 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,21 @@ -Various LaTeX classes. Note that some of this exists as independent LaTeX repostiories (e.g., ouexam, beamerthemes). These are included as git subtrees. +Various LaTeX classes. Note that some of this exists as independent LaTeX repostiories (e.g., ouexam, beamerthemes). You can find these repositories on [Github][]. To install, ensure that `$TEXMFHOME` is set to your personal texmf tree (e.g., `~/.texmf`), then: - % git clone https://github.com/Otago-InfoSci-Database/LaTeX.git - % cd LaTeX - % make install +``` +git clone https://github.com/Otago-InfoSci-Database/LaTeX.git +cd LaTeX +make install +``` Everything should just work beyond that point (fingers crossed! ☺), barring any backwards incompatible changes to classes or the like. -**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. +### For developers only ### -To pull upstream changes to the subtrees (e.g., for `ouexam`): +*Normal users of the LaTeX repository should ignore the following!* - % git subtree pull --prefix=ouexam --squash ouexam master +The `beamerthemes`, `listings`, and `ouexam` subdirectories are git subtrees pointing to independent repositories. If you’re intending to edit the contents of these directories, you make a separate clone of the original repository. -To push changes to the upstream repository (see note above): +To pull upstream changes to the subtrees (e.g., for `ouexam`): `git subtree pull --prefix=ouexam --squash ouexam master` - % git subtree push --prefix=ouexam --squash ouexam master +[github]: https://github.com/nstanger "Github"