Installation

Install Hugo

NB: if you do no intend to build the website locally, you can skip this part.

This website is built with Hugo, and thus requires its installation to build the website locally. The documentation about this is very clear and I (@KevCaz) strongly recommend the use of a package manager, e.g chocolatey on Windows, brew on MacOS, apt-get on Debian/Ubuntu, pacman on ArcLinux, etc.

Clone the repository

For command line interface (CLI) users

You can clone this repository as any other repository

git clone --recurse-submodules https://github.com/McCannLab/McCannLab.github.io.git

But if you intend to rebuild the website locally then you need to include the submodules using the --recurse-submodules option.

git clone --recurse-submodules https://github.com/McCannLab/McCannLab.github.io.git

For GitKraken user

First, it may be the first time you heard about submodule, if so you should better check out this section of GitKraken documentation out.

Notes

Sometimes, an update of the theme will be needed:

git submodule update --init --recursive