Skip to content
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

Please specify instructions better #191

Closed
ghost opened this issue Apr 10, 2019 · 4 comments · Fixed by #395
Closed

Please specify instructions better #191

ghost opened this issue Apr 10, 2019 · 4 comments · Fixed by #395
Labels
topic: documentation Related to documentation for the project

Comments

@ghost
Copy link

ghost commented Apr 10, 2019

On step 4 of the instructions it says to use the command:

arduino-cli core search mkr1000

That's all fine and dandy if you use the mkr1000 but I do not know if that is the arduino I have.

When I google the phrase mkr1000 I get arduino mkr1000 wifi. So I assume that if you had that board you would come across a page that tells you the codeword for that is simply "mkr1000".

I have the arduino uno r3.

When I run the comand:

arduino-cli core search uno

I get:

Searching for platforms matching 'uno'

ID Version Name
arduino:avr 1.6.23 Arduino AVR Boards
arduino:megaavr 1.6.26 Arduino megaAVR Boards


Do I install both of these? Just one? Will either one work?

Please specify in the instructions how to take the brand name of my arduino and look up the model number or whatnot I am supposed to type into the search command OR specify what to do if multiple results come up.

@NormanDunbar
Copy link

Install arduino:avr for an Uno R3. Or indeed, any other Uno.

I agree with your second paragraph.

Cheers,
Norm.

@per1234 per1234 added the topic: documentation Related to documentation for the project label May 24, 2019
@per1234
Copy link
Contributor

per1234 commented May 24, 2019

Related:

This sort of confusion seems to be coming up regularly. I'm not sure how I feel about adding the amount of documentation it would take to make people fully understand how the FQBN system works when that documentation is already present in https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5-3rd-party-Hardware-specification (though interspersed with additional information that is not relevant). I'm leaning towards the opinion that arduino-cli is for more advanced users who have an understanding of how Arduino core packages work or can gain that understanding from reading the hardware specification. For everyone else, there is the IDE. So the documentation would only need a link to the hardware specification with a short explanation of why that information is important.

@NormanDunbar
Copy link

Morning @per1234. Having used an Arduino Duemilanove for some 10 years, looking up docs on the Arduino.cc site as and when required, my first encounter with an FQBN came when I started testing the new CLI. It's fine having docs on Github, but then need to be linked from the official site. I tried searching for it, this was the result:

Your search - Fqbn site:https://www.arduino.cc - did not match any documents.

So, yes, your final sentence is correct, there must be a link to the appropriate docs.

Cheers,
Norm.

@endorama
Copy link
Contributor

endorama commented Jul 11, 2019

@per1234 A note on

or can gain that understanding from reading the hardware specification

The page you linked https://github.com/arduino/Arduino/wiki/Arduino-IDE-1.5-3rd-party-Hardware-specification does not mention the word "fqbn" once. Searching that repo for "fqbn" yields only results in code, commits and issues.
I found pretty difficult to "gain an understanding" and I even opened #271 because I had the same issue with a Nano 33.

I agree with yout about the cli requiring a deeper knowledge of Arduino internals, but we may help a bit in smoothing some edges (in particular the FQBN bit, which is very present in the cli and a bit obscure)

endorama added a commit that referenced this issue Jul 11, 2019
As reported in multiple issues (#138 #191 #271) finding the right FQBN for a board can be difficult.

Improving the documentation may help users to find the relevant information.

Specifically, this PR closes #271 and add little improvement as suggested in #191.
rsora pushed a commit that referenced this issue Jul 11, 2019
As reported in multiple issues (#138 #191 #271) finding the right FQBN for a board can be difficult.

Improving the documentation may help users to find the relevant information.

Specifically, this PR closes #271 and add little improvement as suggested in #191.
mastrolinux pushed a commit that referenced this issue Jul 16, 2019
As reported in multiple issues (#138 #191 #271) finding the right FQBN for a board can be difficult.

Improving the documentation may help users to find the relevant information.

Specifically, this PR closes #271 and add little improvement as suggested in #191.
per1234 pushed a commit that referenced this issue Nov 16, 2020
Use flash strings to conserve RAM space
per1234 added a commit that referenced this issue Aug 9, 2021
Add slice entries to projectdata for all package index components
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants