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 <mrobinson@igalia.com>
This commit is contained in:
Richard Dushime 2024-03-15 15:06:02 -04:00 committed by GitHub
parent 30db7a9a5f
commit d211cfc978
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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