Skip to content

Commit da1f84f

Browse files
authored
Remove number prefix from documentation documents. (#86)
This is really unmanageabable, once a certain number of files has been exceeded.
1 parent 06ea98f commit da1f84f

7 files changed

+9
-9
lines changed

docs/README.md

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

33
`Arduino_Threads/docs`
44
======================
5-
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.
5+
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.
66

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

1515
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).
1616

17-
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.
17+
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.
1818

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

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

34-
1. [Threading Basics](01-threading-basics.md)
35-
2. [Data exchange between threads](02-data-exchange.md)
36-
3. [Threadsafe `Serial`](03-threadsafe-serial.md)
37-
4. [Threadsafe `Wire`](04-threadsafe-wire.md)
38-
5. [Threadsafe `SPI`](05-threadsafe-spi.md)
34+
1. [Threading Basics](threading-basics.md)
35+
2. [Data exchange between threads](data-exchange.md)
36+
3. [Threadsafe `Serial`](threadsafe-serial.md)
37+
4. [Threadsafe `Wire`](threadsafe-wire.md)
38+
5. [Threadsafe `SPI`](threadsafe-spi.md)

docs/06-cli-getting-started.md renamed to docs/cli-getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,4 @@ If everything went as it should, the sketch is now uploading to the board, and o
107107

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

110-
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.
110+
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.

docs/05-threadsafe-spi.md renamed to docs/threadsafe-spi.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Thread-safe `SPI`
44
===============
55
## Introduction
6-
`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.
6+
`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.
77

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

0 commit comments

Comments
 (0)