arduino / arduino-ide

Arduino IDE 2.x
https://www.arduino.cc/en/software
GNU Affero General Public License v3.0
2.34k stars 398 forks source link

fix(doc): add missing prerequisites to dev docs #2531

Closed dankeboy36 closed 1 month ago

dankeboy36 commented 1 month ago

Motivation

When the IDE depends on a non-released version of the Arduino CLI, LS, etc., tools, it must check out the corresponding pinned commit from Git and build them from the sources. This process requires Go, but it's preferable to use taskfile for the correct timestamps and dev versions. This pull request refers to the existing documentation of the Arduino CLI, and it should be sufficient to build all other binaries.

Change description

Document prerequisites of the Arduino CLI, LS, etc. tools when built from a Git commitish.

Other information

The preview version of the change: https://github.com/arduino/arduino-ide/blob/fda5a5f7714aea8fb4c447fa650e839a1473553d/docs/development.md#prerequisites.

closes: arduino/arduino-ide#2499

Reviewer checklist

dankeboy36 commented 1 month ago

I have noticed that https://arduino.github.io/arduino-cli/latest/CONTRIBUTING/#prerequisites redirects to https://arduino.github.io/arduino-cli/0.35/CONTRIBUTING/#prerequisites instead of https://arduino.github.io/arduino-cli/1.0/CONTRIBUTING/#prerequisites. Probably it should be https://arduino.github.io/arduino-cli/1.0.4/CONTRIBUTING/#prerequisites (which is a 404)