Skip to content

Commit c80d2e1

Browse files
committed
Update getting started
1 parent 7135695 commit c80d2e1

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

warduino/guide/get-started.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,12 @@ next: 'Examples'
55

66
In this guide, you will find instructions on how to start programming software for microcontrollers in AssemblyScript and Rust by using WARDuino.
77

8-
## Installation
8+
## 📦️ Prerequisites
9+
10+
- node and npm
11+
- arduino toolchain: [see our guide](#arduino)
12+
13+
## ✨ Installation {#installation}
914

1015
To start writing programs for WARDuino in your favorite language you need to install the WARDuino **language library**.
1116

@@ -33,12 +38,12 @@ Once you have written your program and compiled it to WebAssembly, you need to i
3338

3439
```bash
3540
cd $HOME/Arduino/libraries/
36-
git clone git@github.com:TOPLLab/WARDuino.git
41+
git clone --recurse-submodules --branch v0.4.3 git@github.com:TOPLLab/WARDuino.git
3742
```
3843

3944
WARDuino currently supports both the Arduino and ESP-IDF toolchains. To use Arduino, you need to install the [arduino-cli](https://github.com/arduino/arduino-cli). For ESP-IDF you need to install the full toolchain, instructions can be found on the [official website](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/get-started/index.html#get-started-step-by-step).
4045

41-
## Arduino Toolchain Setup
46+
## 🛠️ Arduino Toolchain Setup {#arduino}
4247

4348
In order to setup the Arduino toolchain for WARDuino, you need to first install the [arduino-cli](https://arduino.github.io/arduino-cli/0.21/installation/).
4449
You will also need `python3` with the `pyserial` package.
@@ -62,7 +67,7 @@ Add the ESP32 board manager URL to the config file:
6267
```yaml
6368
board_manager:
6469
additional_urls:
65-
- https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_dev_index.json
70+
- https://espressif.github.io/arduino-esp32/package_esp32_index.json
6671
```
6772
6873
Then, update the index and install the ESP32 platform.
@@ -83,9 +88,9 @@ arduino-cli lib install "PubSubClient" # for MQTT
8388
arduino-cli lib install "Adafruit NeoPixel"
8489
```
8590

86-
If you haven't done so already, clone (or symlink) the WARDuino repository to `~/Arduino/libraries/WARDuino` to make it available to Arduino.
91+
If you haven't done so already, clone (or symlink) the WARDuino repository to `~/Arduino/libraries/WARDuino` to make it available to Arduino. (see [#installation](#installation))
8792

88-
## Flashing using Arduino
93+
## 📸 Flashing using Arduino
8994

9095
After setting up the Arduino toolchain, you can upload your programs with the Makefile in the `platforms/Arduino` folder of the WARDuino virtual machine.
9196
You can supply all the arguments through the command-line, or write all of them in a `.config` file in the same directory as the Makefile.
@@ -107,7 +112,7 @@ make flash
107112

108113
Command-line arguments always overwrite commands in the `.config` file.
109114

110-
## Flashing using ESP-IDF
115+
## 📸 Flashing using ESP-IDF
111116

112117
::: warning Under construction
113118
Primitive support for IDF is incomplete (see [implementation status](/reference/primitives)).

0 commit comments

Comments
 (0)