ReleaseProcedure.txt

RGBD Release TODO List:

To create a release package, start with the last release package version and update only the files changed

Building the release:
Build new version for Windows and OS X.

For both operating systems, go through the whole process from calibrating, capturing visualizing and exporting to be sure no weird bugs snuck in.

When you're sure it's ready, update the changelog and README with the new version number (1) and any workflow changes from this new version
For each platform:
	-- Copy the old release folders 
	-- Replace application files, and README files, and shaders in both the with and without example data folders

Make sure that when you open the app with example data, that the example composition loads automatically.

Updating the git repositories:

Whene releasing a new toolkit version, push the current develop branches into master and tag it with the version number.

Do this for the associated addons, most critically tag:
	ofxDepthKit
	ofxTimeline
	ofxCv

Because changes in these addons tend to dramatically effect the function of the toolkit.

Creating a source package:
With each release, the full source code needs to be uploaded as well. To prepare the source release:
	-- copy the entire openFrameworks source folder
	-- delete everything but the following directories:
		openFrameworks/libs
		openFrameworks/apps
		openFrameworks/addons

	-- in openFrameworks/addons/ delete all the addons that aren't associated with the toolkit
	-- in openFrameworks/apps delete everything but the RGBDToolkit folder
	-- in openFrameworks/apps/DepthKit/ delete any uncommitted or experimental apps


(1) Note about DepthKit version numbers: 
This is modeled roughly after how the openFrameworks version numbers work. 
DepthKit preRelease 00XY

X is the major release, and is incremented whenever a significant change has been made to the toolkit. During the pre release period it is OK to break project compatibility with old projects when releasing a new major version

Y is the minor version. Releases that are intended to fix bugs or small problems, compatibility should remain intact with the current major version.