embassy/docs/modules/ROOT/pages/getting_started.adoc

= Getting started

So you want to try Embassy, great! To get started, there are a few tools you need to install:

* link:https://rustup.rs/[rustup] - the Rust toolchain is needed to compile Rust code.
* link:https://crates.io/crates/probe-run[probe-run] - to flash the firmware on your device. If you already have other tools like `OpenOCD` setup, you can use that as well.

If you don't have any supported board, don't worry: you can also run embassy on your PC using the `std` examples.

== Getting a board with examples

Embassy supports many microcontroller families, but the easiest ways to get started is if you have one of the more common development kits.

=== nRF kits

* link:https://www.nordicsemi.com/Products/Development-hardware/nrf52-dk[nRF52 DK]
* link:https://www.nordicsemi.com/Products/Development-hardware/nRF9160-DK[nRF9160 DK]

=== STM32 kits

* link:https://www.st.com/en/evaluation-tools/nucleo-h743zi.html[STM32 Nucleo-144 development board with STM32H743ZI MCU]
* link:https://www.st.com/en/evaluation-tools/nucleo-f429zi.html[STM32 Nucleo-144 development board with STM32F429ZI MCU]
* link:https://www.st.com/en/evaluation-tools/b-l4s5i-iot01a.html[STM32L4+ Discovery kit IoT node, low-power wireless, BLE, NFC, WiFi]
* link:https://www.st.com/en/evaluation-tools/b-l072z-lrwan1.html[STM32L0 Discovery kit LoRa, Sigfox, low-power wireless]
* link:https://www.st.com/en/evaluation-tools/nucleo-wl55jc.html[STM32 Nucleo-64 development board with STM32WL55JCI MCU]
* link:https://www.st.com/en/evaluation-tools/b-u585i-iot02a.html[Discovery kit for IoT node with STM32U5 series]


=== RP2040 kits

* link:https://www.raspberrypi.com/products/raspberry-pi-pico/[Raspberry Pi Pico]

== Running an example

First you need to clone the [github repository];

[source, bash]
----
git clone https://github.com/embassy-rs/embassy.git
cd embassy
git submodule update --init
----

You can run an example by opening a terminal and entering the following commands:

[source, bash]
----
cd examples/nrf52840
cargo run --bin blinky --release
----

== Whats next?

Congratulations, you have your first Embassy application running! Here are some alternatives on where to go from here:

* Read more about the xref:runtime.adoc[executor].
* Read more about the xref:hal.adoc[HAL].
* Start xref:basic_application.adoc[writing your application].