From ee2221ccca57d29f78b7e6cfe398615ab0c0a89f Mon Sep 17 00:00:00 2001 From: JamesKingdom Date: Sun, 20 Aug 2017 03:19:13 +0100 Subject: [PATCH] Updating clone information on readme (closes #4249) --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 251428a3d..70a0cef23 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,24 @@ This is only necessary the first time so that the build process can create symbo To run the current development version of iD on your own computer: -1. Create a local `git clone` of the project, then `cd` into the project folder +#### Cloning the repository + +The repository is reasonably large. and it's unlikely that you need the full history. If you are happy to wait for it all to download, run: + +``` +git clone https://github.com/openstreetmap/iD.git +``` + +To clone only the most recent version, instead use a 'shallow clone': + +``` +git clone --depth=1 https://github.com/openstreetmap/iD.git +``` + +If you want to add in the full history later on, perhaps to run `git blame` or `git log`, run `git fetch --depth=1000000` + +#### Building iD +1. `cd` into the newly cloned project folder 2. Run `npm install` 3. Run `npm run all` 3. Run `npm start`