search

korginc / logue-sdk

This repository contains all the files and tools needed to build custom oscillators and effects for the prologue synthesizer.
BSD 3-Clause "New" or "Revised" License
818 stars 304 forks source link

Features: Makes sdk more standard #27

Open hickscorp opened 4 years ago

hickscorp commented 4 years ago

This PR is an attempt to make the Korg Logue SDK more modern.

It allows projects to reference include files globally so the SDK can be installed in a standard location (Eg /usr/local or ~/.local/opt) and include paths can be properly specified (Eg using #include <logue/whatever.h> vs the old "local" includes #include "whatever.h").

Reciprocally, all examples are also updated and show good practice as per how to import things.

This PR's goal is to prepare the SDK for modern and standard distribution packaging (deb, rpm etc).

Note that I chose to have all include files placed inside a logue folder - so global includes reference it in user projects - but it could be changed easily to anything else - keep in mind that having it clearly contain something vendor-specific is much better to avoid name collisions in the future (which I had in my case, as all .h files were not namespaced in a folder). Also, having inc/utils, inc/dsp should not be done anymore, again because of name collisions. Instead, a user who want to use anything in the utils folder can now refer to it directly (Eg #include <logue/utils/float_whatever.h>). This is also reflected in the example projects.

hickscorp commented 3 years ago

Any chance we could get this merged? The vanilla really doesn't feel very professional - having to include it in each project (vs what my PR does - eg have it at one place of your system and being able to reference it from all user projects).

These are pretty standard conventions applied here...

hickscorp commented 2 years ago

Bump? Anyone? Dead projecy?