openframeworks / openframeworks/openFrameworks
PG should generate example projects in non-core addons
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 10.4k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 9
Description
It would be great if the PG could get an option to generate the examples of non-core addons which the user has downloaded and placed in OF/addons/. This would really be useful to quickly look at/work with an addon.
The PG already knows about these addons. It would scan for folders in am addon's root directory with example in the name somewhere, and probably check the requisite structure (src folder, addons.make in place, etc), then generate the project file just the way it would if the example were in OF/examples/addons/someExample. Folder depth is the same, so I hope this is just a matter of adjusting the root folder for the example generation process - addons instead of examples.
Thoughts? Feedback?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the project generator (PG) code that discovers addon examples, comparing its handling of OF/examples/addons with installed OF/addons directories. Trace how it validates example structure and generates project files. Done means eligible examples from downloaded non-core addons are discovered and generate projects consistently with core addon examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- build-system
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100