Skip to content

Commit 3e5cb23

Browse files
committed
update README w/ Xcode 7 compat and naming change
1 parent 69b2925 commit 3e5cb23

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
OFPlugin
1+
OFXcodeMenu
22
========
3+
(formerly OFPlugin)
34

4-
[OpenFrameworks](http://openframeworks.cc) plugin for Xcode that adds addons to your project. Compatible with Xcode 5 and 6 on OS X 10.8+. `HEAD` of this repo is typically paired with the latest Xcode. For older Xcode releases, see the git tags or just checkout OFPlugin at the relevant point in time.
5+
[OpenFrameworks](http://openframeworks.cc) plugin for Xcode that adds addons to your project. Compatible with Xcode 5 - 7 on OS X 10.8+. `HEAD` of this repo is typically paired with the latest Xcode. For older Xcode releases, see the git tags or just checkout OFXcodeMenu at the relevant point in time.
56

67
![screenshot](screenshot.jpg "it does this")
78

@@ -10,9 +11,9 @@ Installing
1011

1112
*Building the included Xcode project will install the plugin*
1213

13-
To control installation manually, add/remove OFPlugin.xcplugin in:
14+
To control installation manually, add/remove OFXcodeMenu.xcplugin in:
1415

15-
~/Library/Application Support/Developer/Shared/Xcode/Plug-ins/OFPlugin.xcplugin
16+
~/Library/Application Support/Developer/Shared/Xcode/Plug-ins/OFXcodeMenu.xcplugin
1617

1718
You may need to create a few of the directories on the way, as they don't all exist by default.
1819

@@ -21,30 +22,30 @@ The plugin can also be installed via the [Alcatraz](http://alcatraz.io/) Xcode p
2122
Known Issues
2223
============
2324

24-
When addons contain static libs, they will be added with absolute paths. This is due to a quirk in the Xcode API being used by OFPlugin. If you intend to share a project with other people, it is recommended that you re-add static libs yourself (by right-clicking in the project navigator and selecting "Add Files To (project name)...", for example). You can also edit the project's .pbxproj file yourself if you're feeling brave.
25+
When addons contain static libs, they will be added with absolute paths. This is due to a quirk in the Xcode API being used by OFXcodeMenu. If you intend to share a project with other people, it is recommended that you re-add static libs yourself (by right-clicking in the project navigator and selecting "Add Files To (project name)...", for example). You can also edit the project's .pbxproj file yourself if you're feeling brave.
2526

2627
Troubleshooting
2728
===============
2829

2930
**"I updated Xcode and now the plugin doesn't show up"**
3031

31-
Xcode works on a UUID whitelist system, meaning each new version of Xcode needs to have its UUID added to OFPlugin's Info.plist file. If OFPlugin isn't updated in time, you can do this update yourself (and by all means send a pull request afterwards!).
32+
Xcode works on a UUID whitelist system, meaning each new version of Xcode needs to have its UUID added to OFXcodeMenu's Info.plist file. If OFXcodeMenu isn't updated in time, you can do this update yourself (and by all means send a pull request afterwards!).
3233

3334
Get the UUID by running the following in the terminal:
3435

3536
```
3637
defaults read /Applications/Xcode.app/Contents/Info DVTPlugInCompatibilityUUID
3738
```
38-
Then, open the OFPlugin project and edit the Supporting Files > OFPlugin-Info.plist file. You'll need to add the UUID you just copied to the DVTPlugInCompatibilityUUIDs section.
39+
Then, open the OFXcodeMenu project and edit the Supporting Files > OFXcodeMenu-Info.plist file. You'll need to add the UUID you just copied to the DVTPlugInCompatibilityUUIDs section.
3940

4041
Rebuild the plugin, restart Xcode and you should see the OF menu reappear.
4142

4243
**"I want to use this plugin with non-latest Xcode"**
4344

44-
OFPlugin has been kept in sync with Xcode starting from Xcode 5, though only the latest Xcode is supported by github HEAD. To use with an older Xcode, you will have to checkout to an older OFPlugin commit and rebuild.
45+
OFXcodeMenu has been kept in sync with Xcode starting from Xcode 5, though only the latest Xcode is supported by github HEAD. To use with an older Xcode, you will have to checkout to an older OFXcodeMenu commit and rebuild.
4546

4647
**"The plugin isn't adding my addon correctly"**
4748

48-
The plugin parses addons_config.mk and will use it to tell which system frameworks to add, which folders to ignore, extra includes to add, etc. Example folders are always ignored by default. It will also use some of the metadata, such as the dependency list and addon url. If your addon doesn't work with OFPlugin properly out-of-the-box, you should add an addon_config.mk. See ofxKinect and ofxMidi for examples.
49+
The plugin parses addons_config.mk and will use it to tell which system frameworks to add, which folders to ignore, extra includes to add, etc. Example folders are always ignored by default. It will also use some of the metadata, such as the dependency list and addon url. If your addon doesn't work with OFXcodeMenu properly out-of-the-box, you should add an addon_config.mk. See ofxKinect and ofxMidi for examples.
4950

50-
If OFPlugin doesn't seem to be parsing your addon_config.mk properly, please [open an issue](https://github.com/admsyn/OFPlugin/issues).
51+
If OFXcodeMenu doesn't seem to be parsing your addon_config.mk properly, please [open an issue](https://github.com/openframeworks/OFXcodeMenu/issues).

0 commit comments

Comments
 (0)