Skip to content

Commit f68a737

Browse files
Update README.md wp-content guidance
Co-authored-by: Bastian Greshake Tzovaras <bgreshake@proton.me>
1 parent 51d2ca8 commit f68a737

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,17 @@ hugo server &
6262
At the moment (2025-03-05), historic images live in a large separate repo
6363
https://github.com/OBF/wp-content/ which is included as a git submodule.
6464
If you want to view images in the web pages on localhost:1313, you will need
65-
to have cloned that repo via the `git submodule update` command above.
65+
to also initialise this repository, which is currently setup using the
66+
`git submodule` workflow. **By default the `wp-content` submodule is not cloned**
67+
68+
To load it you can run:
69+
70+
* `cd OBF.github.io/`
71+
* `git submodule init`
72+
* `git submodule update`
73+
74+
Getting the files can take a while (the `wp-content` repo is ~500 MB).
75+
6676

6777
This may change.
6878

0 commit comments

Comments
 (0)