Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 17 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,29 @@ This documentation includes lessons for teachers
and API documentation for developers (check out the index on the left). We hope
you enjoy developing for the BBC micro:bit using MicroPython.

If you're a new programmer, teacher or unsure where to start, begin with the tutorials.

.. image:: comic.png
If you're a new programmer, teacher or unsure where to start, begin with the
:ref:`Tutorials <Tutorials>` and use the `micro:bit Python Editor <https://python.microbit.org>`_
to program the micro:bit.

.. note::

This project is under active development. Please help other
developers by adding tips, how-tos, and Q&A to this document.
Thanks!
The MicroPython API will not work in the MakeCode editor, as this
uses a `different version of Python. <https://support.microbit.org/support/solutions/articles/19000111744-makecode-python-and-micropython>`_

.. image:: comic.png

Projects related to MicroPython on the BBC micro:bit include:

* `Mu <https://github.com/ntoll/mu>`_ - a simple code editor for kids, teachers and beginner programmers. Probably the easiest way for people to program MicroPython on the BBC micro:bit.
* `uFlash <https://uflash.readthedocs.io/en/latest/>`_ - a command line tool for flashing raw Python scripts onto a BBC micro:bit.
* `micro:bit Python Editor <https://python.microbit.org>`_ - A simple
browser-based code editor, developed by the Micro:bit Educational
Foundation and designed to help teachers and learners get the
most out of text-based programming on the micro:bit.

* `Mu <https://codewith.mu>`_ - A simple offline code editor for kids, teachers
and beginner programmers.

* `uFlash <https://uflash.readthedocs.io/en/latest/>`_ - A command line tool
for flashing raw Python scripts onto a BBC micro:bit.

.. toctree::
:maxdepth: 2
Expand Down
17 changes: 8 additions & 9 deletions docs/tutorials/introduction.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,17 @@
Introduction
------------
.. _Tutorials:

We suggest you download and use the `mu editor <http://codewith.mu/>`_ when
working through these tutorials. Instructions for downloading and installing
Mu are on its website. You may need to install a driver, depending on your
platform (instruction are on the website).
We suggest you use the `micro:bit Python Editor <https://python.microbit.org>`_
or `Mu <https://codewith.mu/>`_ when working through these tutorials.

Mu works with Windows, OSX and Linux.
Connect your micro:bit to your computer via a USB lead.

Once Mu is installed connect your micro:bit to your computer via a USB lead.
Write your script in the editor window and click the "Download" or "Flash" button to
transfer it to the micro:bit.

Write your script in the editor window and click the "Flash" button to transfer
it to the micro:bit. If it doesn't work, make sure your micro:bit appears as
a USB storage device in your file system explorer.
If you have any problems with MicroPython or the editor, you can get support from the
Micro:bit Educational Foundation team via `support.microbit.org <https://support.microbit.org>`_.

.. toctree::
:maxdepth: 2
Expand Down