diff --git a/README.md b/README.md index e69de29..f34ccea 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,24 @@ +## Get submodules + +This project includes the [Agaric styleguide](https://gitlab.com/agaric/styleguide) as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). + +### When cloning + +``` +git clone --recurse-submodules git@gitlab.com:agaric/sites/agaric-com.git +``` + +### If you cloned without `--recurse-submodules` + +If in your initial clone you didn't do as above, you can get the styleguide with: + +``` +git submodule init +git submodule update +``` + +### Get updates + +``` +git submodule update --recursive --remote +```