From c7be10f0f58170a43852e663ed32a906b7a15466 Mon Sep 17 00:00:00 2001 From: Adriaan Moors Date: Tue, 26 Jun 2018 10:14:30 +0200 Subject: [PATCH 1/2] Mention submodules in getting started doc --- docs/docs/contributing/getting-started.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/docs/contributing/getting-started.md b/docs/docs/contributing/getting-started.md index 5400538e96d7..ef7295e5f943 100644 --- a/docs/docs/contributing/getting-started.md +++ b/docs/docs/contributing/getting-started.md @@ -20,8 +20,11 @@ $ git clone --recursive --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`. The `managedSources` sbt task 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: From 652fbf3d332b2956a8db56f75ab57a92c2685e98 Mon Sep 17 00:00:00 2001 From: Allan Renucci Date: Tue, 28 Aug 2018 16:16:16 +0200 Subject: [PATCH 2/2] Cleanup --- docs/docs/contributing/getting-started.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/contributing/getting-started.md b/docs/docs/contributing/getting-started.md index ef7295e5f943..761c96a53c7c 100644 --- a/docs/docs/contributing/getting-started.md +++ b/docs/docs/contributing/getting-started.md @@ -16,14 +16,14 @@ 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`. The `managedSources` sbt task will alert you if this is needed. +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: