From d211cfc97870f436485b35a357a66ff4824cc3d5 Mon Sep 17 00:00:00 2001 From: Richard Dushime <45734838+richarddushime@users.noreply.github.com> Date: Fri, 15 Mar 2024 15:06:02 -0400 Subject: [PATCH] documentation: Add instructions for creating a shallow clone of the Servo repository (#31697) * Add support for partial and shallow clones for contributors with limited internet access * Fix requested changes * small typo * Removed Trailing spaces and Fixed req changes * Small fixes to the new documentation --------- Co-authored-by: Martin Robinson --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 585915de242..d0216816b40 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,17 @@ for help getting started. Visit the [Servo Project page](https://servo.org/) for news and guides. ## Getting Servo + ``` sh git clone https://github.com/servo/servo cd servo ``` -Your CARGO_HOME needs to point to (or be in) the same drive as your Servo repository (See [#28530](https://github.com/servo/servo/issues/28530)). + + - Your CARGO_HOME needs to point to (or be in) the same drive as your + Servo repository ([#28530](https://github.com/servo/servo/issues/28530)). + - The Servo repository is big! If you have an unreliable network connection, consider + [making a shallow clone](https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/). + ## Build Setup