VersionPrep for v1.0.0 (changelog) (#386)

* updated changelog for new version, added migration details for breaking change. * updated version in CMakeLists and version.h for new release. Co-authored-by: stephenhensley <[email protected]>
electro-smith · Jul 21, 2021 · df034a5 · df034a5
1 parent 6f78393
commit df034a5
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,13 +1,13 @@
 # libDaisy Changelog
 
-## Unreleased
+## v1.0.0
 
 ### Breaking Changes
 
 * move MidiEvent and related data to `daisy` namespace.
 
 ### Features
- 
+
 * string: allow more integer types in `FixedCapStr::AppendInt()`
 * fifo/stack: Add new methods for searching elements
 * fifo/stack: Reduce binary size
@@ -31,7 +31,16 @@
 
 ### Migrating
 
+With `using namespace daisy` (as typical in example programs) no changes necessary. Otherwise:
+
+```c++
+// Old
+MidiEvent event;
+
+// New
+daisy::MidiEvent event;
+```
+
 ## v0.1.0
 
 Initial Release
-
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,5 +1,5 @@
 cmake_policy(SET CMP0048 NEW)
-project (libdaisy VERSION 0.1.0)
+project (libdaisy VERSION 1.0.0)
 cmake_minimum_required(VERSION 3.20)
 
 set(TARGET daisy)

diff --git a/src/version.h b/src/version.h
@@ -2,8 +2,8 @@
 #ifndef DSY_VERSION_H
 #define DSY_VERSION_H
 
-#define LIBDAISY_VER_MAJ 0
-#define LIBDAISY_VER_MIN 1
+#define LIBDAISY_VER_MAJ 1
+#define LIBDAISY_VER_MIN 0
 #define LIBDAISY_VER_PATCH 0
 
 #endif