forked from LibreSchool/libreschool.org
updated readme
This commit is contained in:
parent
19675d1bfd
commit
22b147f0eb
30
README.md
30
README.md
@ -2,10 +2,32 @@
|
|||||||
|
|
||||||
Libreschool website
|
Libreschool website
|
||||||
|
|
||||||
## Development instructions ##
|
## Development instructions
|
||||||
|
|
||||||
Clone repo with the command:
|
Clone repo with the command:
|
||||||
|
|
||||||
$ git clone --recurse-submodules ssh://git@git.libreschool.org:1022/LibreSchool/libreschool.org.git
|
```sh
|
||||||
$ cd libreschool.org
|
git clone --recurse-submodules ssh://git@git.libreschool.org:1022/LibreSchool/libreschool.org.git
|
||||||
$ hugo serve
|
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.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user