Skip to content

Commit d75da14

Browse files
committed
README: clarify how to start working on this site locally
The information was all there, but a couple of concrete commands that can be copy/pasted go a long way to be even more helpful. Signed-off-by: Johannes Schindelin <[email protected]>
1 parent 205db72 commit d75da14

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
@@ -8,7 +8,15 @@ This site is built with [Hugo](https://gohugo.io/) and served via GitHub Pages.
88

99
## Local development setup
1010

11-
It is highly recommended to clone this repository using [`scalar`](https://git-scm.com/docs/scalar); This allows to work only on the parts of the repository relevant to your interests. You can select which directories are checked out using the [`git sparse-checkout add <directory>...`](https://git-scm.com/docs/git-sparse-checkout) command. The relevant directories are:
11+
It is highly recommended to clone this repository using [`scalar`](https://git-scm.com/docs/scalar); This allows to work only on the parts of the repository relevant to your interests. You can select which directories are checked out using the [`git sparse-checkout add <directory>...`](https://git-scm.com/docs/git-sparse-checkout) command. Typically, you will want to start like this:
12+
13+
```
14+
scalar clone http://github.com/git/git-scm.com
15+
cd git-scm.com/src
16+
git sparse-checkout set /layouts/ /content/ /static/ /assets/ /hugo.yml /data/ /script/
17+
```
18+
19+
Here is a detailed list of the relevant directories:
1220

1321
- If you want to test any page rendering using Hugo:
1422
- layouts/

0 commit comments

Comments
 (0)