Skip to content

Commit 2d341e0

Browse files
README: Recommend installing git instead of GitHub Desktop. (#71)
As the GitHub app doesn't add git to PATH.
1 parent 64707d7 commit 2d341e0

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Native Build Status](https://github.com/lancaster-university/microbit-v2-samples/actions/workflows/build.yml/badge.svg)](https://github.com/lancaster-university/microbit-v2-samples/actions/workflows/build.yml) [![Docker Build Status](https://github.com/lancaster-university/microbit-v2-samples/actions/workflows/docker-image.yml/badge.svg)](https://github.com/lancaster-university/microbit-v2-samples/actions/workflows/docker-image.yml)
44

5-
This repository provides the necessary tooling to compile a C/C++ CODAL program for the micro:bit v2 and generate a HEX file that can be downloaded to the device.
5+
This repository provides the necessary tooling to compile a C/C++ CODAL program for the micro:bit V2 and generate a HEX file that can be downloaded to the device.
66

77
## Raising Issues
88
Any issues regarding the micro:bit are gathered on the [lancaster-university/codal-microbit-v2](https://github.com/lancaster-university/codal-microbit-v2) repository. Please raise yours there too.
@@ -11,7 +11,7 @@ Any issues regarding the micro:bit are gathered on the [lancaster-university/cod
1111
You need some open source pre-requisites to build this repo. You can either install these tools yourself, or use the docker image provided below.
1212

1313
- [GNU Arm Embedded Toolchain](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads)
14-
- [Github desktop](https://desktop.github.com/)
14+
- [Git](https://git-scm.com)
1515
- [CMake](https://cmake.org/download/)
1616
- [Python 3](https://www.python.org/downloads/)
1717

@@ -45,7 +45,7 @@ To omit the final output stage (for CI, for example) run without the `--output`
4545
# Building
4646
- Clone this repository
4747
- In the root of this repository type `python build.py`
48-
- The hex file will be built `MICROBIT.HEX` and placed in the root folder.
48+
- The hex file will be built `MICROBIT.hex` and placed in the root folder.
4949

5050
# Developing
5151
You will find a simple main.cpp in the `source` folder which you can edit. CODAL will also compile any other C/C++ header files our source files with the extension `.h .c .cpp` it finds in the source folder.
@@ -61,7 +61,7 @@ To use it, simply copy the additional json entries into your `codal.json` file,
6161
If you are using Visual Studio Code, there is a working debugging environment already set up for you, allowing you to set breakpoints and observe the micro:bit's memory. To get it working, follow these steps:
6262

6363
1. Install either [OpenOCD](http://openocd.org) or [PyOCD](https://github.com/pyocd/pyOCD).
64-
2. Install the `marus25.cortex-debug` VS Code extension.
64+
2. Install the [`marus25.cortex-debug` VS Code extension](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug).
6565
3. Build your program.
6666
4. Click the Run and Debug option in the toolbar.
6767
5. Two debugging options are provided: one for OpenOCD, and one for PyOCD. Select the correct one depending on the debugger you installed.

0 commit comments

Comments
 (0)