Skip to content

Commit

Permalink
docs: Improve dev guide's installation and firmware flash instructions.
Browse files Browse the repository at this point in the history
  • Loading branch information
Nathanator authored and dpgeorge committed Sep 6, 2021
1 parent a92ca9b commit e7bdb46
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 4 deletions.
13 changes: 10 additions & 3 deletions docs/devguide/flashfirmware.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,15 +36,22 @@ targets.
Preparing firmware and a Python program
---------------------------------------

tools/makecombined

hexlify
A script in the following location, called using the following syntax, should
help::

tools/makecombinedhex.py <firmware.hex> <script.py> [-o <combined.hex>]

The script will output to ``stdout`` if no output option (``-o``) is provided.

Flashing to the micro:bit
-------------------------

The Microbit mounts itself as a mass storage device over USB. When it detects
that a .hex file has been uploaded to the internal mass storage device, it will
flash itself with the bytecode representation, and start running the program.

This means that uploading a .hex file should result in the Microbit running your
code.



Expand Down
10 changes: 9 additions & 1 deletion docs/devguide/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,22 @@ Debian/Ubuntu, and Red Hat Fedora/Centos.
Debian and Ubuntu
^^^^^^^^^^^^^^^^^

::
The following commands should install the toolchain on a modern Debian/Ubuntu
variant::

sudo add-apt-repository -y ppa:team-gcc-arm-embedded
sudo add-apt-repository -y ppa:pmiller-opensource/ppa
sudo apt-get update
sudo apt-get install cmake ninja-build gcc-arm-none-eabi srecord libssl-dev
pip3 install yotta

In order to make development life a bit easier, you can (on Ubuntu) add yourself
to the ``dialout`` group, which grants write access to the serial device
``/dev/ttyACM0``::

sudo usermod -a -G dialout ${USER}

You may need to relogin in order for the changes to groups to take effect.

.. _microbit-redhat:

Expand Down

0 comments on commit e7bdb46

Please sign in to comment.