Skip to content

Commit 47f0c82

Browse files
committed
extend to includ info about submodules and hugo serve
1 parent 3f98e7e commit 47f0c82

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,20 @@ I can give you most of a website for satRdays events, ready (almost) out of the
4444
If you want to have a website set up, please request this in the #satrdays-website slack channel of the R User Group organizers Slack (rusergroups.slack.com), tagging @DaveParr.
4545

4646
## Organiser tasks
47+
48+
### Build locally
49+
50+
You can locally build your site using the shell command `hugo serve` in the working directory of the project, as long as you have it [installed on your machine](https://gohugo.io/getting-started/installing/). You can then open you browser to the link that is listed in the message (probably localhost:1313), and see your changes. Hugo features fast builds and hot-reload so you should be able to see _most_ changes simply after saving the relevant file.
51+
52+
#### Initialise the sub-modules
53+
54+
When you locally clone your events repo to your machine, the first time you build the project you _might_ need to initialise the sub-modules which contain the theme. You do this in 2 shell commands in the working directory of the project.
55+
56+
```
57+
git submodule init
58+
git submodule update
59+
```
60+
4761
### Edit the base url in `config.toml`
4862
Change
4963
```

0 commit comments

Comments
 (0)