Specific platform build guide (#32797)

* add guide for specific platforms checkout * reduce space add by mistake * Restyled by prettier-markdown --------- Co-authored-by: Restyled.io <[email protected]>
project-chip · May 22, 2024 · 1662076 · 1662076
1 parent 2bdaddc
commit 1662076
Showing 1 changed file with 42 additions and 1 deletion.
diff --git a/docs/guides/BUILDING.md b/docs/guides/BUILDING.md
@@ -25,11 +25,52 @@ The Matter build system has the following features:
 
 ## Checking out the Matter code
 
-To check out the Matter repository, run the following command:
+To check out the Matter code, there are two options: one is to check out all
+platforms together, which is recommended; the other is to check out with support
+for specific platforms, which can obviously reduce the project size.
+
+### Checking out All Platforms
+
+To check out the Matter repository with all platforms, run the following
+command:
 
 ```
 git clone --recurse-submodules [email protected]:project-chip/connectedhomeip.git
+
+```
+
+### Specific platforms Checking out
+
+-   first step, checking out matter top level repo with command below:
+
 ```
+  git clone --depth=1 [email protected]:project-chip/connectedhomeip.git
+
+```
+
+-   Second step, check out third-party platform support repos as follows:
+
+```
+  python3 scripts/checkout_submodules.py --shallow --platform platform1,platform2...
+
+```
+
+For Linux host example:
+
+```
+ ./scripts/checkout_submodules.py --shallow --platform  linux
+
+```
+
+For Darwin host example:
+
+```
+ ./scripts/checkout_submodules.py --shallow --platform  darwin
+
+```
+
+Please note that in the above commands, you should replace platform1,platform2
+with the specific platform names you wish to check out.
 
 ## Updating Matter code