search

Rybec / pyRTOS

RTOS written in pure Python, designed for use with CircuitPython
MIT License
150 stars 28 forks source link

Add CHANGELOG.md #7

Closed Rybec closed 3 years ago

Rybec commented 3 years ago

CHANGELOG.md will be for documenting changes between major versions. Specifically, it will explain how to update code written in one major version to work in the next.

The big things it needs for the v0 to v1 transition are the removal of anonymous Mutex locking, the demotion of Task Mailboxes to an opt-in feature, and the addition of the Task Notification opt-in feature. (Tasks are now lightweight by default.)

Necessary changes to user code are passing in self when attempting to lock a Mutex and setting the mailbox keyword argument to True when creating Tasks that need to receive messages.

Rybec commented 3 years ago

Oh, don't forget: Service Routines were added. This won't require any transition instructions, but it is a new feature that should probably be mentioned.

Rybec commented 3 years ago

Change log added for v1.0.0.