openframeworks / openframeworks/openFrameworks
docs in OF_ROOT/docs seem somewhat out of date
Open
Nobody has claimed this yet.
documentation
- Dominant language
- C++
- Stars
- 10.4k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 9
Description
some of these docs look a little out of date or could use love:
- linux, needs info about what script you need to run for the project generator. Also, is code::blocks supported?
- vs, info seems really thin here and should be rewritten for tone. help clarify vs 2012 for 0.8.4, vs2015 for 0.9, etc...
- codeblocks, should we delete this?
- apps and examples, seems thin -- not sure what the point of this is
- xcode, is there more info we can provide? This doc suggests the old way of making a new project (copy and paste).
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 in OF_ROOT/docs and review the linux, vs, codeblocks, apps and examples, and xcode documents together. Verify the project-generator instructions and platform/version guidance, then decide which outdated or unnecessary sections need revision or removal. Done means the affected documents accurately explain current workflows and their purpose is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp, linux, macos
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100