Skip to content

Commit 9f2ce64

Browse files
committed
Link to getting started guide as well as arduino-cli documentation.
1 parent f300c4b commit 9f2ce64

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/06-cli-getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ For now, you need to use the Arduino CLI to upload sketches made with the `Ardui
88
This document will help you get started, showing you how to find all the information you need to get off the ground without needing to go in depth and learn everything there is to know about the CLI.
99

1010
## Installing
11-
To use the Arduino_Threads library, a special version of the Arduino CLI needs to be downloaded and installed. Installing the Arduino CLI is really just as simple as downloading it and extracting the files from the .zip archive, once it is on your computer it is installed. However, to keep your workflow tidy and organized, we recommend moving it to a directory with a short path. If you have been using the Arduino IDE, most likely the files are stored in your `Documents` folder, so let's put the CLI files in the same place.
11+
To use the `Arduino_Threads` library, a special version of the Arduino CLI needs to be downloaded and installed. Installing the Arduino CLI is really just as simple as downloading it and extracting the files from the .zip archive, once it is on your computer it is installed. However, to keep your workflow tidy and organized, we recommend moving it to a directory with a short path. If you have been using the Arduino IDE, most likely the files are stored in your `Documents` folder, so let's put the CLI files in the same place.
1212

1313
Make a new folder in your `Documents` folder, and name it `CLI`, extract the files from the .zip archive to this folder.
1414

docs/README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,9 @@ The following Arduino architectures and boards are currently supported:
1212

1313
### Tooling
1414

15-
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).
15+
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).
16+
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.
1618

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

0 commit comments

Comments
 (0)