openframeworks / openframeworks/openFrameworks

Need help checking / updating setup guides

Open
#7,625 18 comments 0 reactions 0 assignees View on GitHub

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!

Now 0.12.0 is out we'd love to get a little help checking and updating the current setup instructions for each platform.

We're looking for volunteers to review a current setup guide. eg: Xcode or Raspberry Pi and make suggestions / changes so it works with the current IDE and 0.12.0.

Guides:

Drops/Adds:

If you are interested in helping with a guide just drop a note in this issue.

The markdown files for the guides currently live here:
https://github.com/openframeworks/ofSite/tree/master/content/setup

A PR to the ofSite is ideal, but feel free to share a gist or by any means and we'll get it updated.

Many thanks!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The guides are markdown files in the openframeworks/ofSite content/setup directory. Choose one unchecked platform guide, compare its instructions with the current IDE and openFrameworks 0.12.0, and review the platform-specific setup steps. Done means submitting an ofSite PR with the guide updated, or sharing the proposed changes as a gist.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, linux, raspberry-pi, vscode
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.