Skip to content

Commit fcad6b0

Browse files
hamoidarturoc
authored andcommitted
INSTALL_FROM_GITHUB: Include how-to-update section (#6474)
1 parent d443178 commit fcad6b0

File tree

1 file changed

+50
-2
lines changed

1 file changed

+50
-2
lines changed

INSTALL_FROM_GITHUB.md

Lines changed: 50 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## How to compile openFrameworks from github
1+
# How to compile openFrameworks from github
22

33
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.
44

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

46-
## How to submit your pull requests
46+
47+
48+
# How to update openFrameworks from github
49+
50+
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
51+
52+
git remote -v
53+
54+
And study the output. It may look something like this:
55+
56+
```
57+
origin [email protected]:your-user-name/openFrameworks.git (fetch)
58+
origin [email protected]:your-user-name/openFrameworks.git (push)
59+
upstream https://github.com/openframeworks/openFrameworks.git (fetch)
60+
upstream https://github.com/openframeworks/openFrameworks.git (push)
61+
```
62+
63+
This means that there are two remotes:
64+
- the first two lines point at your own fork in github
65+
- the next two lines point at the official openFrameworks repository
66+
67+
It is possible that you only have one or the other. If you are missing the official remote you can add it like this:
68+
69+
git remote add upstream [email protected]:openframeworks/openFrameworks.git
70+
71+
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:
72+
73+
git pull upstream master
74+
75+
### Update the submodules
76+
77+
The openFrameworks git repository has submodules (so far the Project Generator). The submodules rarely change, but if they did, you can update them too. If you never downloaded the submodules, do it now:
78+
79+
git submodule update --init --recursive
80+
81+
If you did already download them, this is how you update them:
82+
83+
git submodule update --recursive
84+
85+
### Try if everything worked
86+
87+
Once all 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.
88+
89+
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.
90+
91+
92+
93+
94+
# How to submit your pull requests
4795

4896
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:
4997

0 commit comments

Comments
 (0)