Skip to content

Commit 1d56d1c

Browse files
committed
Updates to the documentation regarding the mbed new --scm [scm|none]
1 parent 152e066 commit 1d56d1c

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,20 @@ mbed CLI allows creating new programs and importing existing ones, always with t
8585

8686
#### Creating a new program
8787

88-
When you create a new program, *mbed-cli* automatically imports the [mbed-os library](https://github.com/ARMmbed/mbed-os/) for you. This library represents a **release** of mbed OS and will pull in all the components of the OS, including its build system and desktop IDE project generators.
88+
When you create a new program, *mbed CLI* automatically imports the [mbed-os library](https://github.com/ARMmbed/mbed-os/) for you. This library represents a **release** of mbed OS and will pull in all the components of the OS, including its build tools and desktop IDE project generators.
8989

9090
With this in mind, these are the steps for creating a new program (we'll call it `myprog`):
9191

9292
```
93-
$ mbed new myprog # this creates a new folder "myprog", initializes a new repository and imports the latest revision of the mbed-os dependency to your program tree.
93+
$ mbed new myprog
94+
```
95+
96+
This creates a new folder "myprog", initializes a new repository and imports the latest revision of the mbed-os dependency to your program tree.
97+
98+
You can use `mbed ls` to list all imported libraries to your program.
99+
```
94100
$ cd myprog
95-
$ mbed ls -a # this lists all libraries in your program
101+
$ mbed ls -a
96102
myprog (no revision)
97103
`- mbed-os (https://github.com/ARMmbed/mbed-os/#e472a51e45f30d793cbb430b6ebf3e1c53d82f57)
98104
|- core\mbedtls (https://mbed.org/teams/sandbox/code/mbedtls/#bef26f687287)
@@ -114,8 +120,7 @@ myprog (no revision)
114120
`- net\sal-stack-nanostack-private (https://github.com/ARMmbed/sal-stack-nanostack-private-mirror/#1374c77b03fb900425c09a1dd9a0cb8b4e4904ea)
115121
```
116122

117-
118-
<span class="notes">**Note**: At the moment, if you want to start from an existing folder in your workspace, you can simply use `mbed new .`, which will initialize a new Git or Mercurial repository in that folder. While this might seem like a limitation, it helps with correct versioning for all program files, and helps mbed-cli find mbed-os and tooling. You can always drop the version control by removing the ``.git`` or ``.hg`` source management folders.</span>
123+
<span class="notes">**Note**: If you want to start from an existing folder in your workspace, you can simply use `mbed new .`, which will initialize an mbed program and also initialize a new Git or Mercurial repository in that folder. You can control which source control management is used or prevent source control management initialization via `--scm [name|none]` option.</span>
119124

120125

121126
#### Importing an existing program

0 commit comments

Comments
 (0)