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

Unclear README for compiling firmware. #1117

Closed
TheBuzzAldrin opened this issue Sep 7, 2018 · 2 comments · Fixed by #3842
Closed

Unclear README for compiling firmware. #1117

TheBuzzAldrin opened this issue Sep 7, 2018 · 2 comments · Fixed by #3842
Labels

Comments

@TheBuzzAldrin
Copy link

At the bottom of the 'Development environment preparation' section in the README.md, step #3 asks that you do the following:
"modify platform.txt to enable float printf support: "compiler.c.elf.flags=-w -Os -Wl,-u,vfprintf -lprintf_flt -lm -Wl,--gc-sections""

However it is not explained WHERE this file is located.

I was having issues getting 3.4.0 to compile, and discovered I edited the wrong file.
There are two that I found while trying to follow the instructions.

In the first attempt I tried to edit the 'platform.txt' in the base of the 'hardware' folder inside the arduino installation location by adding the requested line to the bottom. This did not work and the 3.4.0 firmware refused to compile.
I then went searching and found one inside the 'hardware/arduino/avr' subfolder, which already has a line containing 'compiler.c.elf.flags' which I edited and THAT allowed the firmware to compile successfully.

I ask that the README.md be updated with a line under instruction #3 inside the 'Development environment preparation' section explaining how to find the proper platform.txt file.

@geeksville
Copy link

In fact, if you are editing the README, a better instruction would be to have people just create a platform.local.txt file (which is where local settings go that you don't want blown away by arduino updates. This also makes it easier because the person is just creating a new one line file.

On my linux machine the file would be at:
~/.arduino15/packages/arduino/hardware/avr/1.6.13/platform.local.txt

I can send in a PR that fixes the README if you want it?

@geeksville
Copy link

@PavelSindler I created a pull request for this change if you want it (also happy to tweak/clarify) #1201

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants