Skip to content

Mention submodules in getting started doc #4719

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 28, 2018
Merged

Mention submodules in getting started doc #4719

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7be10f
Mention submodules in getting started doc
adriaanm Jun 26, 2018
652fbf3
Cleanup
allanrenucci Aug 28, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion docs/docs/contributing/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,15 @@ Compiling and Running
Start by cloning the repository:

```bash
$ git clone --recursive --single-branch https://github.com/lampepfl/dotty.git
$ git clone --recurse-submodules --single-branch https://github.com/lampepfl/dotty.git
$ cd dotty
$ sbt managedSources # Needed for IDE import to succeed
```

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)).

The repository uses submodules, which may need updating/initializing using `git submodule update --init`. Starting `sbt` will alert you if this is needed.

Dotty provides a standard sbt build: compiling, running and starting a repl can
all be done from within sbt:

Expand Down