Working with Source Code

The YCweather source code as well as the web-site and end-user compiled code is stored in a git repository on github.com. The following sections detail the necessary steps to edit and update the software.

Acquiring a Working Copy

1. Download and install git: http://git-scm.com.
2. Open the git command-line interface.
3. Navigate on the command line to the desired storage location for the source code.
4. Clone the YCweather master branch from the repository:
   git clone -b master git@github.com:aeslaughter/YCweather.git
   This branch contains the actual MATLAB source code for YCweather.
5. Clone the branch that contains the web-site:
   git clone -b gh-pages git@github.com:aeslaughter/YCweather.git
6. Switching between the two branches is then done using the following:
   git checkout gh-pages git checkout master

Making Changes to YCweather MATLAB Code

After making changes to the MATLAB code for YCweather the following steps, using the git command-line, should be taken to update your local repository and the remote github.com repository.

1. Investigate the files changed: git status
2. Add the files for committing: git add <filename here>
3. Commit the changes to your local repository: git commit -m "Some changes were made..."
4. Push the changes to the github.com repository: git push origin

Making Changes Available to Users

If the source code is changed and you want the changes to be made available to users of YCweather the following steps should be followed. It is required that you have a working copy of INNO Setup: http://www.jrsoftware.org/isinfo.php.

MATLAB Commands

• Update the version number in MAIN.m
• Compile the changes into executables (x.x is the new version number): >> YCbuild('build',x.x)
• Copy the necessary files to the release directory: >> YCbuild('release')
• Copy the latest changes to the Dropbox folder (this step is only needed if new weather data was added): >> YCbuild('dropbox')

GIT command-line

• Checkout the web-page branch: git checkout gh-pages
• Copy the release directory from the master branch: git checkout master -- release
• Comitt the changes to your local repository: git commit -a -m "A message detailing changes to the gh-pages branch..."
• Push the changes to remote repository: git push origin gh-pages