This documentation is created with hugo a static website generator

install hugo #

Installing hugo is quite simple, as it’s a standalone binary that can be downloaded and added to the system path

clone this repo #

Note the recusive clone to add the git submodules as well

>git clone --recursive https://github.com/TheSoundOfAIOSR/website.git
>cd website

test locally #

no generation is required to test locally, hugo takes care of generating and serving

>hugo server

deploy #

generate the website in the public folder

>hugo

make sure you commit and push the public submodule before the top repo

doc support #

• for questions or issues related to how to use or contribute to the documentation

doc maintainer #

• for any other questions