Skip to content

Remove number prefix from documentation documents. #86

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 26, 2022
Merged
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
14 changes: 7 additions & 7 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -2,7 +2,7 @@

`Arduino_Threads/docs`
======================
The Arduino threading APIs brings multi-threading to the world of Arduino. If you're new to the concept of threads we suggest you have first a look at the [Threading Basics](01-threading-basics.md) document.
The Arduino threading APIs brings multi-threading to the world of Arduino. If you're new to the concept of threads we suggest you have first a look at the [Threading Basics](threading-basics.md) document.

The following Arduino architectures and boards are currently supported:
* `mbed_portenta`: [Portenta H7](https://store.arduino.cc/products/portenta-h7)
@@ -14,7 +14,7 @@ The following Arduino architectures and boards are currently supported:

Threading with the above mentioned Arduino cores can be achieved by leveraging the [Arduino_Threads](https://github.com/bcmi-labs/Arduino_Threads) library in combination with the [Arduino Command Line Interface](https://github.com/facchinm/arduino-cli/commits/arduino_threads_rebased) (arduino-cli).

For those who are unsure how to use the Arduino CLI in combination with multi-threading take a look a condensed [getting started guide](06-cli-getting-started.md). There's also the comprehensive [arduino-cli documentation](https://arduino.github.io/arduino-cli/getting-started) to consider.
For those who are unsure how to use the Arduino CLI in combination with multi-threading take a look a condensed [getting started guide](cli-getting-started.md). There's also the comprehensive [arduino-cli documentation](https://arduino.github.io/arduino-cli/getting-started) to consider.

Download a preliminary, pre-built `arduino-cli` binary (experimental) or patched `Arduino IDE` (very experimental) for your operating system that supports threading:
| Platform | Download CLI | Download IDE |
@@ -31,8 +31,8 @@ Download a preliminary, pre-built `arduino-cli` binary (experimental) or patched

In the following documents you will find more information about the topics covered by this library.

1. [Threading Basics](01-threading-basics.md)
2. [Data exchange between threads](02-data-exchange.md)
3. [Threadsafe `Serial`](03-threadsafe-serial.md)
4. [Threadsafe `Wire`](04-threadsafe-wire.md)
5. [Threadsafe `SPI`](05-threadsafe-spi.md)
1. [Threading Basics](threading-basics.md)
2. [Data exchange between threads](data-exchange.md)
3. [Threadsafe `Serial`](threadsafe-serial.md)
4. [Threadsafe `Wire`](threadsafe-wire.md)
5. [Threadsafe `SPI`](threadsafe-spi.md)
Original file line number Diff line number Diff line change
@@ -107,4 +107,4 @@ If everything went as it should, the sketch is now uploading to the board, and o

![Uploaded sketch](./assets/uploaded.png)

Now that you know how to do this, it might be a good opportunity to take the deep dive in the DIY-spirit, experiment with different workflows and interfaces for the terminal to tailor your Arduino experience to your liking.
Now that you know how to do this, it might be a good opportunity to take the deep dive in the DIY-spirit, experiment with different workflows and interfaces for the terminal to tailor your Arduino experience to your liking.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/05-threadsafe-spi.md → docs/threadsafe-spi.md
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@
Thread-safe `SPI`
===============
## Introduction
`SPI` communication shares the same problems that [have been outlined](04-threadsafe-wire.md) for using `Wire` in a multithreaded environment. This is due to the fact that every `SPI` transaction consists of multiple function calls, i.e.
`SPI` communication shares the same problems that [have been outlined](threadsafe-wire.md) for using `Wire` in a multithreaded environment. This is due to the fact that every `SPI` transaction consists of multiple function calls, i.e.

```C++
digitalWrite(cs, LOW);
File renamed without changes.