QCalc.UsersGuide.ReleaseNotes

After version 1.0.0, the changes in each release of QCalc will be summarized in subsections below. Until then, please see the commit log of the master branch. The version management subsection describes how the library is developed and maintained using the git version control system.

Extends from Icons.ReleaseNotes (Icon for release notes in documentation (from MSL 3.2.1)).

Package Contents

Name	Description
VersionManagement	Version management

QCalc.UsersGuide.ReleaseNotes.VersionManagement

QCalc is maintained with three main branches on GitHub at https://github.com/kdavies4/QCalc:

master

This branch contains the released versions. The version numbers have the form of Major.Minor.Patch in accordance with the Semantic Versioning Specification. All of the commits on this branch are tagged with the version number (e.g., v1.0.0). Each tag message contains a one-line summary of the changes in the version.

The version and versionDate entries of the annotation of the top-level package (QCalc) are populated appropriately, e.g.,

  annotation(version     = "1.0.0",
             versionDate = "2014-01-25 16:41:20Z");

The name of the folder that contains the Modelica source files has the form of "QCalc Major.Minor.Patch" (e.g., "QCalc 1.0.0").

TODO Update:

develop

All development work is done on this branch or its sub-branches. This branch and its sub-branches are typically only accessed by library developers, not by library users. Once finished, all sub-branches are merged back into the main develop branch (with option --no-ff) and eventually deleted.

The version and versionDate entries of the annotation of the top-level package (QCalc) are left blank in this branch, e.g.,

  annotation(version     = "",
             versionDate = "");

The name of the folder that contains the Modelica source files is "QCalc".

gh-pages

This is an orphan branch for the web page of the library, which is hosted at http://kdavies4.github.io/QCalc/. All of the content is built from the Modelica documentation of the library. This branch does not contain the Modelica source files or other distribution files.