release docs for alpha release (#1594)

* release docs for alpha release

* Automated formatting of repo files

* Update CHANGELOG.md

Co-authored-by: Ryan Mast <[email protected]>

Co-authored-by: HELICS-bot <[email protected]>
Co-authored-by: Ryan Mast <[email protected]>

CHANGELOG.md

@@ -8,6 +8,28 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 A note on future revisions.
 Everything within a major version number should be code compatible (with the exception of experimental interfaces). The most notable example of an experimental interface is the support for multiple source inputs. The APIs to deal with this will change in future minor releases. Everything within a single minor release should be network compatible with other federates on the same minor release number. Compatibility across minor release numbers may be possible in some situations but we are not going to guarantee this as those components are subject to performance improvements and may need to be modified at some point. Patch releases will be limited to bug fixes and other improvements not impacting the public API or network compatibility. Check the [Public API](./docs/Public_API.md) for details on what is included and excluded from the public API and version stability.
 
+## [3.0.0][] ~ 2020-09-24
+
+HELICS 3.0 is a major update to HELICS. The major features that have been added are the command interface and targeted Endpoints. Internally major changes include updating the minimum compiler to C++17, and updates to internal libraries. The binary serialization protocol was shifted from Cereal to a custom format that embeds the data type so is more suitable to HELICS data types. The initial release is an alpha release for some initial testing. The full change log will be filled out as the release progresses from lpha to beta to final release. The [migrating 2 to 3](./docs/developer-guide/porting-2-to-3.md) page includes some specific details on migrating from HELICS 2 to 3.
+
+### Changed
+
+- Data serialization moved to a custom protocol specific to HELICS.
+- Minimum build requirements to C++17
+- Many of the API functions now use `string_view` instead of `const std::string &`
+
+### Fixed
+
+### Added
+
+- Command interface
+- Targeted Endpoints
+
+### Removed
+
+- Message structure from C API
+- Deprecated functions from HELICS 2
+
 ## [2.6.0][] ~ 2020-08-20
 
 Bug fixes and major logging update
@@ -772,3 +794,4 @@ This is a major revision so this changelog will not capture all the changes that
 [2.5.1]: https://github.com/GMLC-TDC/HELICS/releases/tag/v2.5.1
 [2.5.2]: https://github.com/GMLC-TDC/HELICS/releases/tag/v2.5.2
 [2.6.0]: https://github.com/GMLC-TDC/HELICS/releases/tag/v2.6.0
+[3.0.0]: https://github.com/GMLC-TDC/HELICS/releases/tag/v3.0.0-alpha.1

CMakeLists.txt

@@ -14,9 +14,9 @@ project(HELICS VERSION 3.0.0)
 # -----------------------------------------------------------------------------
 # HELICS Version number
 # -----------------------------------------------------------------------------
-set(HELICS_VERSION_BUILD "pre-alpha")
+set(HELICS_VERSION_BUILD "alpha.1")
 # use ISO date YYYY-MM-DD
-set(HELICS_DATE "2020-09-05")
+set(HELICS_DATE "2020-09-24")
 
 set(HELICS_VERSION_UNDERSCORE
     "${HELICS_VERSION_MAJOR}_${HELICS_VERSION_MINOR}_${HELICS_VERSION_PATCH}"