diff --git a/README.md b/README.md index ce5d6c8..d0b05be 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ # What is this -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. -Included in the installer is the latest stable version of all tools required to develop in the mbed Ecosystem with mbed CLI. +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. +Included in the installer is the latest stable version of all tools required to develop in the Mbed Ecosystem with Mbed CLI. - Python 2.7.x -- GCC ARM compiler -- mbed CLI +- GNU Arm Embedded Toolchain (GCC) +- Mbed CLI - mbedls - mbed-greentea - mbed-host-tests -- any other relevant mbed python utilities +- any other relevant Mbed Python utilities ## How to use Download the .dmg file, open it. Copy the app to your applications folder. Run application from your applications folder. ## How does it work -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. +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. ## Why? -Because we want something that 'just works' for users in a consistent, reproducable way. +Because we want something that "just works" for users in a consistent, reproducable way. ## But I like installing my tools myself -Cool, you can do that too. See the instructions [here](TODO) for how to install all the tools individually on your system. +See the instructions [here](TODO) for how to install all the tools individually on your system. ## Whats next? Go build awesome. @@ -29,7 +29,7 @@ Go build awesome. # How to Build 1) Update all dependencies in repo (GCC, Python Eggs, ...etc) - - 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 + - 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 - 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. 2) Run the command `sudo sh ./CreateInstaller.sh` 3) The app is now in `dist/MBED_CLI.app`