openframeworks / openframeworks/openFrameworks

Add git source note to Linux install documentation

Open
#6,768 1 comment 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 there! I am new to the project and thus going through setup/compilation for the first time and documenting where I am having trouble. I cloned the repository from github instead of downloading it and am following this install guide: https://github.com/openframeworks/openFrameworks/blob/271863cd2d6ef3901048d9b6aafdd24e360cecfc/docs/linux.md

I found 2 things that were tricky:

  1. I needed to run scripts/linux/download_libs.sh
  2. The examples don't work

And being new to the project, I didn't know where to find this information and just assumed the docs were out of date. So I am thinking it might be helpful to add a little note to the Linux install guide, like "NOTE: If cloning the repository from Github, please refer to https://github.com/openframeworks/openFrameworks/blob/master/INSTALL_FROM_GITHUB.md#how-to-compile-openframeworks-from-github for additional setup steps".

Also it seems like https://github.com/openframeworks/openFrameworks#developers and https://github.com/openframeworks/openFrameworks/blob/master/INSTALL_FROM_GITHUB.md#how-to-compile-openframeworks-from-github overlap in their information, maybe we should also link to https://github.com/openframeworks/openFrameworks/blob/master/INSTALL_FROM_GITHUB.md#how-to-compile-openframeworks-from-github from the README.

What do you think?

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

Start with docs/linux.md and compare its setup steps with INSTALL_FROM_GITHUB.md#how-to-compile-openframeworks-from-github, including scripts/linux/download_libs.sh. Check the README Developers section for overlapping guidance. Done means the Linux guide clearly points cloned repositories to the additional setup steps and any README cross-link is consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, github, linux
Domain
documentation, operating-systems
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.