Difference between revisions of "How to create a new BOARD18 download"

From BOARD18 Project WIKI
Jump to navigation Jump to search
(Initial version of this page)
 
(Perform these steps on your development PC: expanded procedure)
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
These instructions assume that you already have a  board18 development
 
These instructions assume that you already have a  board18 development
 
environment and access to the branch for which the download is to be created.
 
environment and access to the branch for which the download is to be created.
 +
 +
The command lines below assumme that a zip file for board18-2.3.0 is being created.
 +
This string should be modified to the correct release.
  
 
==Perform these steps on your development PC==
 
==Perform these steps on your development PC==
* Checkout the branch for the required board18 release.
+
* If necessary, checkout the branch for the required board18 release.
* Checkout the branch for the required gamebox release.
+
* Start an edit session on the board18com.js file in the BOARD18/scripts sub directory.
 +
<pre>
 +
/* All board18 global variables are contained in one
 +
* 'master variable' called BD18.  This isolates
 +
* them from global variables in other packages.
 +
*/
 +
var BD18 = {};
 +
BD18.noteTimeout = null; // Used by doLogNote().
 +
BD18.welcomename = null; // Used by doLogNote().
 +
BD18.help = "http://wiki.board18.org/w/Player%27s_Guide_V2.0";
 +
BD18.version = "2.3.2";
 +
</pre>
 +
* Modify the value of BD18.version and also, if necessary, of BD18.help.
 +
* Save the edited file.
 +
* Start an edit session on the config.sh file in the BOARD18/makedist sub directory.
 +
<pre>
 +
# This file must be updated with the proper parameters before
 +
# BOARD18make is run to create a new BOARD18 distribution.
 +
 
 +
# Set versionNo to the version number of the new distribution
 +
versionNo="2.3.2"
 +
 
 +
# Set BD18Root to the root of the BOARD18 directory structure.
 +
BD18Root=~/MyDevelopmentDirectory/BOARD18root/
 +
 
 +
</pre>
 +
* Perform the edits specified in this file as shown above.
 +
* Save the edited file.
 
* Open a command line window.
 
* Open a command line window.
* cd to the BOARD18 directory.
+
* cd to the BOARD18/makedist sub directory.
 
* Enter on command line:  
 
* Enter on command line:  
 
<pre>  
 
<pre>  
rm ~/board18.zip
+
./BOARD18make
rm ~/utility.zip
 
zip ~/board18.zip *.html *.php
 
zip -r ~/board18.zip php scripts style
 
zip ~/board18.zip images/*.*
 
zip ~/board18.zip Documentation/Board18Design.pdf
 
zip ~/board18.zip Documentation/ReleaseNotes.txt
 
zip ~/board18.zip Documentation/README.txt
 
cd php
 
zip ~/utility.zip config.php
 
cd ../utility
 
zip ~/utility.zip *.*
 
 
</pre>
 
</pre>
* cd to GAMEBOX directory.
+
* This script should create a zip file in your root directory called something like board18-n.n.n.zip.
* Enter on command line:
+
 
<pre>
+
== Setup the Download on the BOARD18 WIKI==
cd boxes
+
* Go to the BOARD18 WIKI.  
zip -r ~/board18.zip images
+
* Upload the newly created zip file into the wiki.
zip -r ~/utility.zip control
+
* Edit the [[Download BOARD18]] page and add the new release.
</pre>
+
 
* Using FTP, move the 2 zip files to the download server.
 
  
== Setup the Download on the Server==
+
[[Category:HowTo]]

Latest revision as of 09:16, 2 October 2016

These instructions assume that you already have a board18 development environment and access to the branch for which the download is to be created.

The command lines below assumme that a zip file for board18-2.3.0 is being created. This string should be modified to the correct release.

Perform these steps on your development PC

  • If necessary, checkout the branch for the required board18 release.
  • Start an edit session on the board18com.js file in the BOARD18/scripts sub directory.
/* All board18 global variables are contained in one
 * 'master variable' called BD18.  This isolates 
 * them from global variables in other packages. 
 */
var BD18 = {};
BD18.noteTimeout = null; // Used by doLogNote().
BD18.welcomename = null; // Used by doLogNote().
BD18.help = "http://wiki.board18.org/w/Player%27s_Guide_V2.0";
BD18.version = "2.3.2";
  • Modify the value of BD18.version and also, if necessary, of BD18.help.
  • Save the edited file.
  • Start an edit session on the config.sh file in the BOARD18/makedist sub directory.
# This file must be updated with the proper parameters before
# BOARD18make is run to create a new BOARD18 distribution.

# Set versionNo to the version number of the new distribution
versionNo="2.3.2"

# Set BD18Root to the root of the BOARD18 directory structure.
BD18Root=~/MyDevelopmentDirectory/BOARD18root/

  • Perform the edits specified in this file as shown above.
  • Save the edited file.
  • Open a command line window.
  • cd to the BOARD18/makedist sub directory.
  • Enter on command line:
 
./BOARD18make
  • This script should create a zip file in your root directory called something like board18-n.n.n.zip.

Setup the Download on the BOARD18 WIKI

  • Go to the BOARD18 WIKI.
  • Upload the newly created zip file into the wiki.
  • Edit the Download BOARD18 page and add the new release.