openframeworks / openframeworks/openFrameworks
Document Project Generator / clean out old tools
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 10.4k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 9
Description
Hey all
A few sections of the repo need some love to put them in line with the project generator:
- Readme's
- Rogue old project generators
- Document complementing tools
Readme
The readme's in the root of the repo need some love
none of them mention project generator
i feel like each should be a description of how to get to a working project generator on each of the respective platforms
also note:
- .vs2010 is missing
- readme.txt repeats information from the other readme's (i.e. it's a list of platform specific instructions)
i think this should be perhaps a little description of oF and a few tips on how to get started
Rogue old 'project generators' / documenting complementary tools for project generator
Here's things I can find in the repo which don't make sense to me at the moment:
openFrameworks\scripts\????\compileAllExamples.bat
** is this supposed to be run (optionally) after the project generator?
** why is the project template within this folder?openFrameworks\scripts\????\createProjects.py
** if this isn't supposed to be used anymore, lets delete it immediately (we can always recover in emergencies)
and the 'other' folder in the root.. perhaps never took off?
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
Review the root README files, the missing .vs2010 reference, and the project-generator-related paths under openFrameworks/scripts, including compileAllExamples.bat and createProjects.py. Determine which generators and complementary tools are still current, then document the supported workflows and clarify or remove obsolete material, including the root other folder.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- build-system, documentation, tooling
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100