Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Include how-to-update section #6474

Merged
merged 4 commits into from
Nov 27, 2019
Merged

Include how-to-update section #6474

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
af1ae87
Include how-to-update section
hamoid Nov 26, 2019
233c1a7
Improve how-to-update-from-git readme based on feedback
hamoid Nov 26, 2019
48fbb65
Update INSTALL_FROM_GITHUB.md
hamoid Nov 26, 2019
9602439
Update INSTALL_FROM_GITHUB.md
hamoid Nov 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 41 additions & 2 deletions INSTALL_FROM_GITHUB.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## How to compile openFrameworks from github
# How to compile openFrameworks from github

Follow these instructions only if you want to submit a pull request or if you want to always use the most recent version of openFrameworks. In other cases you will not need to clone the entire openFrameworks repository.

Expand Down Expand Up @@ -43,7 +43,46 @@ Once the success message appears you are done.
#### Option 2 - With the command line Project Generator
* from the OF root directory, run `projectGenerator -r -o"." examples`

## How to submit your pull requests


# How to update openFrameworks from github

It's likely that at some point you will want to update your local openFrameworks to include new changes available in github. To update openFrameworks, we first need to figure out if you have several remotes already configured. Run

git remote -v

And study the output. It may look something like this:

```
origin git@github.com:your-user-name/openFrameworks.git (fetch)
origin git@github.com:your-user-name/openFrameworks.git (push)
upstream https://github.com/openframeworks/openFrameworks.git (fetch)
upstream https://github.com/openframeworks/openFrameworks.git (push)
```

This means that there are two remotes:
- the first two lines point at your own fork in github
- the next two lines point at the official openFrameworks repository

It is possible that you only have one or the other. If you are missing the official remote you can add it like this:

git remote add upstream git@github.com:openframeworks/openFrameworks.git

Note that `upstream` is a name you choose, and it's how you will refer to the official openframeworks repository. Use that same name in the following command to update your local copy of openFrameworks:

```bash
git pull upstream master
git submodule update --recursive
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I ran into this recently.
If you haven't pulled in the submodules you have to do this first:
git submodule update --init --recursive

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added :)

```

Once the changes are downloaded try to compile a program. It if fails it is possible that the dependecies are out of date. In that case please repeat the step **Download dependencies** found above.

Finally, if your setup depends on some of the scripts from the scripts folder, you may need to re-run them. For instance, if you use Qt Creator and have trouble creating new OF projects you may want to run `scripts/qtcreator/install_template.sh` again.




# How to submit your pull requests

If you plan to submit pull requests to openFrameworks, the procedure is almost identical to what we described above, with one little difference: you should clone your own fork of openFrameworks:

Expand Down