﻿Updated 2018-10-03

Release Building Notes:

1. On local machine, run `make set ver` (from the RELEASE directory) 
   This will set release info and change versioned files.

2. Optionally, run `make html logo dox jdoc` or some subset of those commands, 
   as desired. This will update the version number in other files (HTML manual, 
   GUI logo, Doxygen, JavaDoc, etc), as described in `make help`

3) (Skip this step if you successfully ran `make dox` and `make jdoc` in step 2)
   Update the version in  manual/RNA_class/Doxygen_configuration 
   Then run Doxygen and JavaDoc.
   Note: If Doxygen or javadoc is run BEFORE `make ver`, the values of some 
         C++ and Java constants will be wrong in the documentation.
         (i.e. from version.h etc)

4) Other files that need manual changes:
	Html Manual:
		manual/Overview/Updates.html      (change-log updates)
		manual/GUI/html/Whats_New.html    (change-log updates)
		manual/RNA_class/Doxygen_configuration  (noted in step 2)
		manual/Overview/index.html     (**)
		manual/GUI/html/Contents.html  (**)
		manual/Text/index.html         (**)
		(**) -- The version number in these HTML files are updated automatically 
		        by step #2 if you run `make html`

	GUI Logo: 
		java_interface/resources/RNAstructureUI/images/logo.psd  (optional)
		java_interface/resources/RNAstructureUI/images/logo.png  (***)
		(***) -- If you have ImageMagick, the PNG file can be automatically
		         generated in step 2 with `make logo`)

5) Now commit all changes (e.g. to a new branch dedicated to this release)

6) Clone the repository on each OS and checkout the release branch you just created.
   (Alternatively, you can use an existing repository and just pull the new branch
    However, ALL files in this repository will be DELETED except those known to Git, 
	which is why a new clone is recommended.

7) In each clone, run "make full"  or  "make x-full"
   The "x" means to perform a Git update and a Git clean prior to building the release.

8) The release is fully automated. Each OS is slightly different, but below is a general sense of the output:

#### The below needs to be updated. It is outdated. #####

~/rna/RELEASE/vX.X
	Sub-Directories:
		source		(raw cvs source...folder name is flexible. e.g. RNAstructure-2015-11-17)
		Windows64
		Windows32
		WindowsGUI
		Linux64
		Linux32
		LinuxGUI
		Mac64
		MacGUI
~/rna/RELEASE/vX.X/output
	Linux:
		RNAstructureLinuxTextInterfaces.tgz			(32-bit CLI)
		RNAstructureLinuxTextInterfaces64bit.tgz	(64-bit CLI)
		RNAstructureForLinux.tgz					(32- & 64-bit GUI)
		RNAstructureSource.tgz						(source code)
	Windows:
		RNAstructureTextInterfaces.exe				(32-bit CLI)
		RNAstructureTextInterfaces64bit.exe			(64-bit CLI)
		RNAstructure.exe							(32- & 64-bit GUI)
		RNAstructureSource.zip						(source code)
	Mac:
		RNAstructureMacTextInterfaces.tgz			(64-bit CLI)
		RNAstructureForMac.tgz						(64-bit Jar Bundle -- GUI)


