Skip to content

Commit

Permalink
Updating docs to clarify the two options for annotating the user pref…
Browse files Browse the repository at this point in the history
…erences class
  • Loading branch information
TheDuckCow committed Jun 27, 2021
1 parent 0cb57d2 commit 0064e51
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,11 @@ Included in this repository is an example addon which is integrates the auto-upd
)
```

7) If Blender version > 2.80, add the decorator `@addon_updater_ops.make_annotations` before the class drawing the preference UI. As shown in the sample demo addon's `DemoPreferences` class, located in the `__init__` file.
7) To support Blender version > 2.80, make one (not necessairly both) of these changes:

a. Add the decorator `@addon_updater_ops.make_annotations` before your addon's user preferences class ([see here](https://github.com/CGCookie/blender-addon-updater/blob/master/__init__.py#L76))

b. Call `make_annotations()`, passing your addon's user preferences class as an input, inside a register function ([see here](https://github.com/CGCookie/blender-addon-updater/blob/master/__init__.py#L152))

8) Add the draw call to any according panel to indicate there is an update by adding this line to the end of the panel or window: `addon_updater_ops.update_notice_box_ui()`
- Again make sure to import the Operator File if this panel is defined in a file other than the addon's `__init__.py` file.
Expand Down

0 comments on commit 0064e51

Please sign in to comment.