summaryrefslogtreecommitdiff
path: root/docs/zephyr/tutorial/intro.rst
diff options
context:
space:
mode:
authorJulia Hathaway <julia.hathaway@nxp.com>2021-08-02 17:01:57 -0500
committerDamien George <damien@micropython.org>2021-08-13 20:20:57 +1000
commit333e16521bc8af8a55f362c1bad2f21c4704d20b (patch)
tree280617f7b9c28b6e2c46c20b0812441455311f26 /docs/zephyr/tutorial/intro.rst
parent42d1a1635cc35fd3a9ae28b19685184fc3c23f1e (diff)
docs/zephyr: Add quick reference for the Zephyr port.
Includes an introduction to using the Zephyr port on MicroPython. The quickref details examples of how to use each module the port currently supports. The tutorial provides additional details for Zephyr specific modules. Signed-off-by: Julia Hathaway <julia.hathaway@nxp.com>
Diffstat (limited to 'docs/zephyr/tutorial/intro.rst')
-rw-r--r--docs/zephyr/tutorial/intro.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/zephyr/tutorial/intro.rst b/docs/zephyr/tutorial/intro.rst
new file mode 100644
index 000000000..ffdbea8b3
--- /dev/null
+++ b/docs/zephyr/tutorial/intro.rst
@@ -0,0 +1,30 @@
+.. _intro_zephyr:
+
+Getting started with MicroPython on the Zephyr port
+===================================================
+
+Let’s get started!
+
+Requirements
+------------
+
+To use the MicroPython Zephyr port, you will need a Zephyr supported board (for a list of acceptable
+boards see :ref:`zephyr_general`).
+
+Powering up
+-----------
+
+If your board has a USB connector on it then most likely it is powered
+through this when connected to your PC. Otherwise you will need to power
+it directly. Please refer to the documentation for your board for
+further details.
+
+Getting and deploying the firmware
+----------------------------------
+
+The first step you will need to do is either clone the `MicroPython repository <https://github.com/micropython/micropython.git>`_
+or download it from the `MicroPython downloads page <http://micropython.org/download>`_. If you are an end user of MicroPython,
+it is recommended to start with the stable firmware builds. If you would like to work on development, you may follow the daily
+builds on git.
+
+Next, follow the Zephyr port readme document (``ports/zephyr/README.md``) to build and run the application on your board.