diff --git a/docs/README.md b/docs/README.md index 1afbd42..0b070ae 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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) diff --git a/docs/06-cli-getting-started.md b/docs/cli-getting-started.md similarity index 99% rename from docs/06-cli-getting-started.md rename to docs/cli-getting-started.md index 9f3581f..29b89a4 100644 --- a/docs/06-cli-getting-started.md +++ b/docs/cli-getting-started.md @@ -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. \ No newline at end of file +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. \ No newline at end of file diff --git a/docs/02-data-exchange.md b/docs/data-exchange.md similarity index 100% rename from docs/02-data-exchange.md rename to docs/data-exchange.md diff --git a/docs/01-threading-basics.md b/docs/threading-basics.md similarity index 100% rename from docs/01-threading-basics.md rename to docs/threading-basics.md diff --git a/docs/03-threadsafe-serial.md b/docs/threadsafe-serial.md similarity index 100% rename from docs/03-threadsafe-serial.md rename to docs/threadsafe-serial.md diff --git a/docs/05-threadsafe-spi.md b/docs/threadsafe-spi.md similarity index 95% rename from docs/05-threadsafe-spi.md rename to docs/threadsafe-spi.md index 079cc04..4d0cd2b 100644 --- a/docs/05-threadsafe-spi.md +++ b/docs/threadsafe-spi.md @@ -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); diff --git a/docs/04-threadsafe-wire.md b/docs/threadsafe-wire.md similarity index 100% rename from docs/04-threadsafe-wire.md rename to docs/threadsafe-wire.md