Skip to content

Commit 25f829c

Browse files
adriaanmallanrenucci
authored andcommitted
Mention submodules in getting started doc (#4719)
Mention submodules in getting started doc
1 parent 45ef446 commit 25f829c

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

docs/docs/contributing/getting-started.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,15 @@ Compiling and Running
1616
Start by cloning the repository:
1717

1818
```bash
19-
$ git clone --recursive --single-branch https://github.com/lampepfl/dotty.git
19+
$ git clone --recurse-submodules --single-branch https://github.com/lampepfl/dotty.git
2020
$ cd dotty
2121
$ sbt managedSources # Needed for IDE import to succeed
2222
```
23+
2324
Pass `--single-branch` to clone only the master branch, otherwise cloning will be *much* slower (details in [issue #3236](https://github.com/lampepfl/dotty/issues/3236)).
2425

26+
The repository uses submodules, which may need updating/initializing using `git submodule update --init`. Starting `sbt` will alert you if this is needed.
27+
2528
Dotty provides a standard sbt build: compiling, running and starting a repl can
2629
all be done from within sbt:
2730

0 commit comments

Comments
 (0)