openframeworks / openframeworks/openFrameworks

core libs inconsistencies

Open
#2,252 12 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

apothecary core development-strategy section-internals
Dominant language
C++
Stars
10.4k
Forks
2.6k
Avg merge
1d 21h
Merged PRs (30d)
9

Description

In writing Apothecary, I noticed a number of small inconsistencies in the libs folders. I'm noting them here.

Assimp

Why is assimp needed for osx in the core libs? I'd think we'd want it in ofxAssimpModelLoader/libs.

Freetype weird nested folder structure

The include path is freetype/include/freetype2/freetype instead of freetype/include.

I assume this is due to weird include paths in freetype?

FreeImage naming

Shouldn't "FreeImage" be "freeimage" to match the lower case lib name convention in OF?

tess2

I'd think the tess2/Sources folder should be tess2/src

Also, the compiled library has the "lib" prefix while all other libraries are renamed without it:

libtess2.a -> tess2.a

rtAudio naming

Shouldn't "rtAudio" be "rtaudio" to match OF lower cased lib name conventions?

Cairo

The win_cb libraries all have the "lib" prefix, while the other cairo platform builds do not.

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 by inspecting the core libs folders and comparing the Assimp, Freetype, FreeImage, tess2, rtAudio, and Cairo layouts and library names across platforms. Determine the intended conventions for locations, casing, include paths, and prefixes; done means the listed inconsistencies are resolved consistently or their exceptions are documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
build-system
Issue type
Refactor
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.