Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SpenceKonde authored Sep 1, 2024
1 parent 4b0b506 commit 5e63d5a
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion megaavr/extras/ioheaders/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# I/O header files
These are the I/O header files from the latest ATpack available at the time of writing, the Atmel AVR Dx Series Device Support v1.10.11 package, supporting all AVR DA and DB parts, as well as the 64k DD-series (likely they will release largest, smallest, and middle size in that order like they did with the DA/DB. Files specific to parts not supported by DxCore are not included. These files are included in the documentation largely because *all post 2016 AVR devices basically require you to have both the datasheet and IO header open* when writing any sort of meaningful code that goes beyond the core and Arduino API functions. (In contrast with older parts, where you needed only the datasheet - the longer names for everything on the modern AVRs are far more readable, and I agree with their decision to pursue the new naming scheme, and these parts are all an incredible improvement; so I don't mean to complain.... but would it have killed them to put the actual word-for-word names for registers/bitfields/etc to copy/paste, so we don't need to keep the header file open too? If you're going to extend the length of the names of bitfields to make for more readable code, that also makes them difficult to type with perfect spelling, capitalization, and underscores in the right places, such that basically everyone will copy-paste them...
These are the I/O header files from the latest ATpack available at the time of writing (or that's what this is probably what we're shipping with) These files are included in the documentation because *all post 2016 AVR devices basically require you to have both the datasheet and IO header open* when writing any sort of meaningful code that goes beyond the Arduino API. (In contrast with older parts, where you needed only the datasheet - the longer names for everything on the modern AVRs are far more readable, and I agree with their decision to pursue the new naming scheme, and these parts are all an incredible improvement; so I don't mean to complain.... but would it have killed them to put the actual word-for-word names for registers/bitfields/etc to copy/paste, so we don't need to keep the header file open too? If you're going to extend the length of the names of bitfields to make for more readable code, that also makes them difficult to type with perfect spelling, capitalization, and underscores in the right places, such that basically everyone will copy-paste them...

I am redistributing these solely as a convenience to users; particularly for less experienced users in the Arduino world, it turns out that being told to look at the header file is a bit daunting ("I found a bunch of iosomething.h files, but not the one for the chip I'm using" "In the Arduino folder? Oh no that's the version that the IDE came with, the core installed a new one..." "well where is it installed to?" "Okay so its in c:/users/(yourusername)/AppData/Arduino15/packages (so on and so forth), but AppData is hidden..." "Uhhhh.... okay can't I just go download it" "Oh of course, you can download it from Microchip - download the file from this page. Then change the file extension to .zip - the download has the .atpack extension, even though it's just a zip file")

Expand Down

0 comments on commit 5e63d5a

Please sign in to comment.