Skip to content

Commit

Permalink
extend info about options to start sub-modules
Browse files Browse the repository at this point in the history
  • Loading branch information
DaveParr committed Jul 6, 2020
1 parent 47f0c82 commit 3af03c6
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,16 @@ You can locally build your site using the shell command `hugo serve` in the work

#### Initialise the sub-modules

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.
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 can avoid this by cloning with the `--recurse-submodules` option, similar to this:

```
git submodule init
git submodule update
git clone --recurse-submodules https://github.com/satrdays/[my_conference_repo]
```

If you fogot that, you can always run this command _after_ you cloned the repo normally:

```
git submodule update --init
```

### Edit the base url in `config.toml`
Expand Down

0 comments on commit 3af03c6

Please sign in to comment.