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

Provide more comprehensive documentation for building arduino-usbserial firmware #596

Open
Pcdwarf opened this issue Mar 6, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement

Comments

@Pcdwarf
Copy link

Pcdwarf commented Mar 6, 2025

Describe the request

Expand the instructions for building the repository's arduino-usbserial firmware to provide all information needed to ensure a successful build by anyone.

Describe the current behavior

I'm trying to build the arduino-usbserial firmware to include custom features. There are instructions for building the firmware:

https://github.com/arduino/ArduinoCore-avr/blob/master/firmwares/atmegaxxu2/arduino-usbserial/readme.txt

However, I find them to be somewhat vague and I have not had any success following them.

ArduinoCore-avr version

c8c514c

Additional context

It would be helpful if the specific version of LUFA verified to be compatible with the firmware code was specified.


Not directly related to the documentation request, but it would also be a good idea to set up a GitHub Actions workflow that builds the firmware on any change to the files, and periodically. This would validate the functionality of the intended build procedure, which might be broken by changes to the firmware or by external changes to the build dependencies.

Related

@per1234 per1234 changed the title need compile method or docker image for firmwares using lufa Provide more comprehensive documentation for building arduino-usbserial firmware Mar 8, 2025
@per1234 per1234 added enhancement documentation Improvements or additions to documentation labels Mar 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement
Projects
None yet
Development

No branches or pull requests

2 participants