Skip to content

Commit d556793

Browse files
authored
Add footnote that abridge is included as submodule (#11)
* Add footnote that abridge is included as submodule * Add command sequence to get started - Move git submodule footnote inline * Link to git submodule help * The latest git-clone docs mention --recurse-submodules
1 parent be7f1ef commit d556793

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,20 @@
22

33
## Local installation
44

5-
The blog is made with [Zola], based on the [Abridge theme].
5+
The blog is made with [Zola] and based on the [Abridge theme] that is included
6+
as a Git [submodule][git-submodule].
67

78
You will need:
89
* The `zola` binary v0.19.1 or higher
910

1011
Run `zola serve` in order to serve the website and automatically render it when files change.
1112

13+
```
14+
$ git clone [email protected]:haskell/blog.haskell.org.git --recurse-submodules
15+
$ cd blog.haskell.org
16+
$ zola serve
17+
```
18+
1219
## Contribute content
1320

1421
### Blog post structure
@@ -60,3 +67,4 @@ documentation-best-practices
6067

6168
[Zola]: https://www.getzola.org/
6269
[Abridge theme]: https://abridge.pages.dev/overview-abridge/
70+
[git-submodule]: https://git-scm.com/docs/git-submodule

0 commit comments

Comments
 (0)