gwrobolib

Cloning Source

This library uses GitHub Wiki for its documentation, and the latest documentation can be found on this repository’s [wiki](https://github.com/GW-Robotics/gwrobolib/wiki).

If you would like to have an offline copy of the documentation in you repository, run the following command after cloning to initialise the docs submodule:

git submodule update --init --recursive

Pushing Documentation

If any offline edits are made that should be pushed to the GitHub Wiki, run the following command:

1. cd docs

2. If you have added new files and want to commit them all: git add --all

3. git commit -a -m "Your commit message here"

4. git push origin HEAD:master

5. Then update the submodule in the main repository:

cd ..
git commit -a -m "Your commit message here"
git push

Pulling Documentation

The documentation for this library is most up-to-date on the GitHub Wiki, but can be updated in the repository using the following command:

git submodule update --recursive --remote

The gitmodule in the main repository must also be pushed to reference the new upstream commit:

git commit -a -m "Your commit message here"
git push