Skip to content
This repository was archived by the owner on Sep 14, 2023. It is now read-only.

Commit 56993ad

Browse files
Merge pull request #1 from yennster/master
Update README
2 parents 0f73901 + 271f39b commit 56993ad

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
# What is this
2-
This is a single click installer for mbed CLI on OSX. If you want the installer please see the Releases page for the latest download link.
3-
Included in the installer is the latest stable version of all tools required to develop in the mbed Ecosystem with mbed CLI.
2+
This is a single click installer for Mbed CLI on OS X. If you want the installer please see the Releases page for the latest download link.
3+
Included in the installer is the latest stable version of all tools required to develop in the Mbed Ecosystem with Mbed CLI.
44
- Python 2.7.x
5-
- GCC ARM compiler
6-
- mbed CLI
5+
- GNU Arm Embedded Toolchain (GCC)
6+
- Mbed CLI
77
- mbedls
88
- mbed-greentea
99
- mbed-host-tests
10-
- any other relevant mbed python utilities
10+
- any other relevant Mbed Python utilities
1111

1212
## How to use
1313
Download the .dmg file, open it. Copy the app to your applications folder. Run application from your applications folder.
1414

1515
## How does it work
16-
When you run the app a Terminal is opened with modified local session variables that link to the versions of python, gcc compiler and mbed tools included in the installer.
16+
When you run the app a Terminal is opened with modified local session variables that link to the versions of Python, the GCC toolchain and Mbed tools included in the installer.
1717

1818
## Why?
19-
Because we want something that 'just works' for users in a consistent, reproducable way.
19+
Because we want something that "just works" for users in a consistent, reproducable way.
2020

2121
## But I like installing my tools myself
22-
Cool, you can do that too. See the instructions [here](TODO) for how to install all the tools individually on your system.
22+
See the instructions [here](TODO) for how to install all the tools individually on your system.
2323

2424
## Whats next?
2525
Go build awesome.
@@ -29,7 +29,7 @@ Go build awesome.
2929

3030
# How to Build
3131
1) Update all dependencies in repo (GCC, Python Eggs, ...etc)
32-
- For compiler updates, unzip the folder into the gcc folder, then modify the setup.py and run-mbed-cli.sh files config section to trace the new path
32+
- For compiler updates, unzip the folder into the GCC folder, then modify the setup.py and run-mbed-cli.sh files config section to trace the new path
3333
- for adding new tools like mbedls and mbed-cli that should have user available calls from the command like `$mbed` you should add them to the `bin` folder. Make sure to modify the shebang to be similar to existing aliases in the bin folder.
3434
2) Run the command `sudo sh ./CreateInstaller.sh`
3535
3) The app is now in `dist/MBED_CLI.app`

0 commit comments

Comments
 (0)