Add details to importer script docs

Add an example showing how to run the importer and a note to indicate
that it must be run from the mbed-os directory.
pull/7875/head
Russ Butler 2018-08-23 16:18:13 -05:00 committed by Russ Butler
parent a2a0ea70e2
commit a62b312d0b
1 changed files with 5 additions and 0 deletions

View File

@ -48,3 +48,8 @@ Note: You must resolve any conflicts that arise during this cherry-pick process.
### Input to importer.py
1. Repository: -r <repo_path> ( Example: CMSIS / Mbed-tls)
2. `repo`_importer.json: -c <json_file> (Example: cmsis_importer.json)
For example the command below can be used to update CMSIS:
`python tools\importer\importer.py -c tools\importer\cmsis_importer.json -r <path to cmsis repo>`
Note: This script must be run from the mbed-os directory to work correctly.