Skip to content

Release 2.0.0: the version and the README for the Library Manager (OIL 4) - #7

Merged
theAndreas merged 4 commits into
mainfrom
release
Nov 11, 2026
Merged

theAndreas merged 4 commits into
mainfrom
release

Conversation

@theAndreas

Copy link
Copy Markdown
Owner

The fourth step of OIL.md: what version 2.0.0 needs before it is tagged and goes into the Library Manager. The code is unchanged since #6.

What changes for a user

  • The library reports version 2.0.0, not 0.1.0. The Library Manager takes the version from the library's properties, so it has to match the tag.
  • The README says how to install the library: through the Library Manager, with arduino-cli, or from the .zip attached to each release.
  • The README shows how to read the time and check whether a value came back.
  • The README says why only pin 3 gives a PWM. Pin 11 is the output of the register that holds the top, so it has no duty of its own.
  • The README says how close a period is met. It is met to one step of the counter and never exceeded, and the size of a step is given at 16 MHz.
  • The README has a table of the flash and RAM each example takes on the Uno, checked against the build.
  • The README says what "version 1" means, as the code before 2.0.0 had no version number of its own.
  • OIL.md: two new items. 4 is in progress, and 6 covers the AVRs whose Timer2 does not have its PWM output on pin 3. The library still allows every AVR, but on the Mega's ATmega2560 that output is pin 9, and the Leonardo's ATmega32U4 has no Timer2 at all.

How it was checked

library.properties allows every AVR, but the PWM pin is 3 for all of them:
on the Mega's ATmega2560 OC2B is pin 9, and the Leonardo's ATmega32U4 has
no Timer2 at all. Found while going through the README for the release.
…L 4)

library.properties still said 0.1.0; the Library Manager reads the
version from it, so it is 2.0.0 to match the tag. The README now says how
to install the library, shows how to read a Result, why only pin 3 gives
a PWM, how close a period is met, and the flash and RAM of the examples
as make examples measures them. OIL.md: 4 is in progress.
@theAndreas
theAndreas merged commit 261fe06 into main Nov 11, 2026
10 checks passed
@theAndreas
theAndreas deleted the release branch November 11, 2026 13:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants