From 93005071f22508e1c8c4aeea7a016d06222da67b Mon Sep 17 00:00:00 2001 From: dehanj Date: Fri, 15 Sep 2023 14:01:15 +0200 Subject: [PATCH] Add release notes --- RELEASE.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 33cefdc..d213c56 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,12 +1,34 @@ # Release notes -## unrelease +## v0.0.2 + +This release contains some changes that forces applications that use +TKey-libs to be updated to work with this release. + +Breaking changes: +- Introducing include hierarchy to make it less generic, e.g., + `#include `. +- Use stdint.h/stddef.h infavor of types.h. +- Library .a files built on top level to simplify inclusion. +- Upgraded Monocypher to 4.0.1. +- QEMU debug behaviour changed, instead of defining `NODEBUG` to + disable debug, one has to enable it by defining `QEMU_DEBUG`. + +Changes: +- Introduce functions to control the LED, led.h and led.c. +- New function, assert() to make an illegal instruction and forcing + the CPU to halt. +- Add functions memcpy_s(), wordcpy_s(), memeq() from firmware +- Adding `const` to MMIO variables and qemu_* functions. +- Minor tweaks, clean up and bugfixes. + +Full changelog: +[v0.0.1...v0.0.2](https://github.com/tillitis/tkey-libs/compare/v0.0.1...v0.0.2) -Upgraded Monocypher to 4.0.1. ## v0.0.1 -Just ripped from +Just ripped from https://github.com/tillitis/tillitis-key1-apps