Skip to content

Commit efae9e2

Browse files
committed
Fix CI run issues with docs & tlsf submodule
1 parent 4794886 commit efae9e2

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

ports/analog/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This port brings CircuitPython to ADI's "MAX32" series of microcontrollers. These devices are mostly ARM Cortex-M4-based and focus on delivering performance at low-power levels. Currently this port only supports MAX32690.
44

5-
### Structure of this port
5+
## Structure of this port
66

77
- **`boards/:`** Board-specific definitions including pins, board initialization, etc.
88
- **`common-hal/:`** Port-specific implementations of CircuitPython common-hal APIs. When a new module is enabled, this is often where the implementation is found. Expected functions for modules in `common-hal` are usually found in `shared-bindings/` or `shared-module/` in the CircuitPy root directory.
@@ -14,7 +14,7 @@ This port brings CircuitPython to ADI's "MAX32" series of microcontrollers. Thes
1414

1515
- `. :` Build system and high-level interface to the CircuitPython core for the ADI port.
1616

17-
### Building for MAX32 devices
17+
## Building for MAX32 devices
1818

1919
Ensure CircuitPython dependencies are up-to-date by following the CircuitPython introduction on Adafruit's Website: [Building CircuitPython - Introduction](https://learn.adafruit.com/building-circuitpython/introduction). In particular, it is necessary to fetch all submodules (including the ARM Toolchain inside MSDK) and build the `mpy-cross` compiler.
2020

@@ -32,7 +32,7 @@ Once you have built `mpy-cross` and set up your build system for CircuitPython,
3232

3333
Be aware the build may take a long time without parallelizing via the `-jN` flag, where N is the # of cores on your machine.
3434

35-
### Flashing the board
35+
## Flashing the board
3636

3737
Universal instructions on flashing MAX32 devices this project can be found in the **[MSDK User Guide](https://analogdevicesinc.github.io/msdk/USERGUIDE/)**.
3838

@@ -48,11 +48,11 @@ This requires the following:
4848
- The PICO board is connected to the target board via a 10-pin SWD ribbon cable.
4949
- If SWD connectors are not keyed, the P1 indicator (red line) on the SWD ribbon cable should match the P1 indicator on the board silkscreen near the 10-pin SWD connector.
5050

51-
### Using the REPL
51+
## Using the REPL
5252

5353
Once the device is plugged in, it will enumerate via USB as both a USB Serial Device (CDC) and a Mass Storage Device (MSC). You can connect to the Python REPL with your favorite Serial Monitor program e.g. TeraTerm, VS Code, Putty, etc. Use any buadrate with 8-bit, No Parity, 1 Stop Bit (8N1) settings. From this point forward, you can run Python code on the MCU! If you want help with learning CircuitPython-specific code or learning Python in general, a good place to start is Adafruit's ["Welcome to CircuitPython"](https://learn.adafruit.com/welcome-to-circuitpython/) guide.
5454

55-
### Editing code.py
55+
## Editing code.py
5656

5757
Python code may be executed from `code.py` the `CIRCUITPY:` drive. When editing this file, please be aware that some text editors will work better than others. A list of suggested text editors can be found at Adafruit's guide here: https://learn.adafruit.com/welcome-to-circuitpython/recommended-editors
5858

ports/analog/boards/apard32690/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,26 +2,26 @@
22

33
This board features the MAX32690, a dual-core ARM Cortex-M4/RISC-V MCU with 3MiB Flash, 1MiB SRAM. The board also has support for 10BASE-T1L Ethernet, Wifi, Bluetooth, USB, and Security via MAXQ1065. However, most of these features are not yet available for this CircuitPython port (USB will be added soon; others are currently unplanned).
44

5-
### Onboard connectors & peripherals
5+
## Onboard connectors & peripherals
66

77
This board comes in a form-factor similar to an Arduino Mega, enabling Arduino-style shield boards to be plugged in and evaluated with the MAX32690. This vastly opens up the options for easily plugging peripherals into the board, especially when combined with the two Pmod:tm: connectors, P8 (SPI) and P13 (I2C).
88

9-
### Product Resources
9+
## Product Resources
1010

1111
For more info about AD-APARD32690-SL, visit our product webpages for datasheets, User Guides, Software, and Design Documents:
1212

1313
[AD-APARD32690-SL Product Webpage](https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/ad-apard32690-sl.html)
1414
[AD-APARD32690-SL User Guide](https://wiki.analog.com/resources/eval/user-guides/ad-apard32690-sl)
1515

16-
#### Building for this board
16+
### Building for this board
1717

1818
To build for this board, ensure you are in the `ports/analog` directory and run the following command. Note that passing in the `-jN` flag, where N is the # of cores on your machine, can speed up compile times.
1919

2020
```
2121
make BOARD=apard32690
2222
```
2323

24-
#### Flashing this board
24+
### Flashing this board
2525

2626
To flash the board, run the following command if using the MAX32625PICO:
2727

tools/ci_fetch_deps.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def matching_submodules(s):
4848
PORT_DEPS = {
4949
"analog": [
5050
"extmod/ulab/",
51-
"/lib/tlsf/",
51+
"lib/tlsf/",
5252
"lib/tinyusb/",
5353
"lib/protomatter",
5454
],

0 commit comments

Comments
 (0)