openframeworks / openframeworks/openFrameworks

Project Generator submodule / install from GitHub process

Open
#7,609 2 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

The instructions to install from GitHub make a half-hearted attempt at people compile their own PG through the submodule, while acknowledging it's not a good idea:

As the first option can lead to unexpected results, we suggest you use the second approach.

that's kind of noisy and not very elegant...

the PG is compiled in a nightly process, and someone tracking git will be interested in the latest PG anyway, which can be obtained for the main platforms: https://github.com/openframeworks/projectGenerator/releases/tag/nightly and someone wanting to compile PG can go to it as a separate project.

so i propose to remove the instructions to try to compile and simply point to the nightlies PG binaries. this focuses the problems of compiling PG in the Project Generator GitHub README.

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

Open the Project Generator GitHub README and find the installation instructions that describe compiling through the submodule. Review the linked nightly release for the available platform binaries, then update the guidance so it points users there and directs people who want to compile the Project Generator to its separate project. Done means the README no longer recommends the submodule build path.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, github
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.