Skip to content

Commit 7bee27a

Browse files
committed
Fix code quotes in documentation
1 parent 442e564 commit 7bee27a

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,23 +58,27 @@ This document covers the installation and usage of *mbed CLI*.
5858

5959
You can get the latest stable version of *mbed CLI* via PyPI by running:
6060

61-
``$ pip install mbed-cli``
61+
```
62+
$ pip install mbed-cli
63+
```
6264

6365
Alternatively you get the development version of *mbed CLI* by cloning the development repository [https://github.com/ARMmbed/mbed-cli](https://github.com/ARMmbed/mbed-cli):
6466

65-
``$ git clone https://github.com/ARMmbed/mbed-cli``
67+
`$ git clone https://github.com/ARMmbed/mbed-cli`
6668

6769
Once cloned you can install *mbed CLI* as a python package:
6870

69-
``$ python setup.py install`` (on Linux/Mac, you may need to run with ``sudo`` as well)
71+
`$ python setup.py install` (on Linux/Mac, you may need to run with `sudo` as well)
7072

7173
<span class="tips">**Note:** *mbed CLI* is compatible with [Virtual Python Environment (virtualenv)](https://pypi.python.org/pypi/virtualenv). You can read more about isolated Python virtual environments [here](http://docs.python-guide.org/en/latest/).</span>
7274

7375
### Uninstalling mbed CLI
7476

7577
To uninstall *mbed CLI*, simply run:
7678

77-
``pip uninstall mbed-cli``
79+
```
80+
pip uninstall mbed-cli
81+
```
7882

7983
## Using mbed CLI
8084

@@ -382,8 +386,8 @@ Through the workflow explained above, mbed CLI will maintain association to the
382386

383387
After importing a program or creating a new one, you need to tell *mbed CLI* where to find the toolchains that you want to use for compiling your source tree. *mbed CLI* gets this information from a file named `mbed_settings.py`, which is automatically created at the top of your cloned repository (if it doesn't already exist). As a rule, since `mbed_settings.py` contains local settings (possibly relevant only to a single OS on a single machine), it should not be versioned. In this file:
384388

385-
* If you want to use the [ARM Compiler toolchain](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler-5/downloads), set ``ARM_PATH`` to the *base* directory of your ARMCC installation (example: c:\software\armcc5.06). The recommended version of the ARMCC toolchain is 5.06 (5.05 will very likely work too).
386-
* If you want to use the [GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), set ``GCC_ARM_PATH`` to the *binary* directory of your GCC ARM installation (example: c:\software\GNUToolsARMEmbedded\4.82013q4\bin). Use versions 4.8 or 4.9 of GCC ARM Embedded, but version 5.0 or any version above might be incompatible with the tools.
389+
* If you want to use the [ARM Compiler toolchain](https://developer.arm.com/products/software-development-tools/compilers/arm-compiler-5/downloads), set `ARM_PATH` to the *base* directory of your ARMCC installation (example: c:\software\armcc5.06). The recommended version of the ARMCC toolchain is 5.06 (5.05 will very likely work too).
390+
* If you want to use the [GCC ARM Embedded toolchain](https://launchpad.net/gcc-arm-embedded), set `GCC_ARM_PATH` to the *binary* directory of your GCC ARM installation (example: c:\software\GNUToolsARMEmbedded\4.82013q4\bin). Use versions 4.8 or 4.9 of GCC ARM Embedded, but version 5.0 or any version above might be incompatible with the tools.
387391

388392
#### Compiling your program
389393

@@ -511,7 +515,7 @@ ___Macros___
511515

512516
You can specify macros in your command line using the -D option. For example:
513517

514-
``$ mbed compile -t GCC_ARM -m K64F -c -DUVISOR_PRESENT``
518+
`$ mbed compile -t GCC_ARM -m K64F -c -DUVISOR_PRESENT`
515519

516520
___Compiling in debug mode___
517521

@@ -526,7 +530,7 @@ $ mbed compile -t GCC_ARM -m K64F -o debug-info
526530

527531
#### Automating toolchain and target selection
528532

529-
Using ``mbed target <target>`` and ``mbed toolchain <toolchain>`` you can set the default target and toolchain for your program, meaning you won't have to specify these every time you compile or generate IDE project files.
533+
Using `mbed target <target>` and `mbed toolchain <toolchain>` you can set the default target and toolchain for your program, meaning you won't have to specify these every time you compile or generate IDE project files.
530534

531535
### Exporting to desktop IDEs
532536

@@ -538,7 +542,7 @@ For example, to export to uVision run:
538542
$ mbed export -i uvision -m K64F
539543
```
540544

541-
A ``.uvproj`` file is created in the projectfiles/uvision folder. You can open the project file with uVision.
545+
A `.uvproj` file is created in the projectfiles/uvision folder. You can open the project file with uVision.
542546

543547
### Testing
544548

@@ -659,7 +663,7 @@ Test code exists in the following directory structure:
659663

660664
```
661665
mbed-os-program
662-
|- main.cpp # Optional main.cpp with ```main()``` if it is an application module.
666+
|- main.cpp # Optional main.cpp with main() if it is an application module.
663667
|- pqr.lib # Required libs
664668
|- xyz.lib
665669
|- mbed-os

0 commit comments

Comments
 (0)