re-coded

Contributing

Although the deadline for submissions for the Day for Night festival has now passed, feel free to contribute a sketch.

This project requires openFrameworks 0.9.0. You can download it from the oF website if you don't already have it installed.

Feel free to create your own fork and open a pull request to have your changes merged into the upstream (SFPC/recoded) repository.

1. Find an artist to work with

Take a look at the project wiki and find an artist you'd like to work with.

2. Checkout the project from GitHub

In you openFrameworks apps folder, create a new folder for the "recoded" project. Then cd into that folder using the terminal and checkout the project from GitHub:

git clone https://github.com/SFPC/recoded.git

3. Make a branch

~~It's probably a good idea to work in your own branch.~~ Actually, probably not totally necessary if you're making a sketch but feel free to do it if you want :).

Create a new branch:

cd recoded
git checkout -b branchName

4. Generate a new scene

Now you can use the scene generator script to generate a new scene. This will copy the emptyScene files and rename based on your new scene name.

Use the terminal to cd into your project folder and run the following, substituting sceneName with the name of your scene:

./generate_scene.sh sceneName

It will copy the following files and create new files for your new scene:

bin/data/scenes/emptyScene/ => bin/data/scenes/sceneName/
src/scenes/emptyScene/ => src/scenes/sceneName/

UPDATED(11.08.17) Now this script also adds the necesary lines to the sceneManager so you don't have to worry about doing so. You just need to edit your new scene files.

Now you you can drag the new folder in the scenes folder into XCode. Make sure to use these settings if you drag the folder in:

5. Submitting Changes

There are two different workflows for submitting changes:

If you're adding a new scene and not changing the architecture

Check to make sure you don't have uncommitted changes (commit them if you do):

git status

Now checkout the master branch and make sure it's up to date:

git checkout master
git pull

Now merge in your branch:

git merge branchName

Now push your changes to the repo:

git push

If you're making architectural changes

It's probably better to push your branch instead of merging directly into master, then submit a pull request.

Check to make sure you don't have uncommitted changes in your branch (commit them if you do):

git status

Now push your branch to GitHub:

git push origin branchName

Now submit a pull request via the GitHub web interface.