diff --git a/README.md b/README.md index 3e319c8..e20ec38 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,32 @@ Libreschool website -## Development instructions ## +## Development instructions Clone repo with the command: - $ git clone --recurse-submodules ssh://git@git.libreschool.org:1022/LibreSchool/libreschool.org.git - $ cd libreschool.org - $ hugo serve +```sh +git clone --recurse-submodules ssh://git@git.libreschool.org:1022/LibreSchool/libreschool.org.git +cd libreschool.org +``` + +If you did clone this repo in the usual way, you probably missed the theme's git submodule. To download the missing submodule: + +```sh +cd libreschool.org +git submodule update --init +``` + +Then start the hugo live server: + +```sh +hugo serve +``` + +You can produce the complete website with: + +```sh +hugo +``` + +The complete website will be placed in the `public` directory.