elk-audio / elk-examples

Example collection for Elk
https://elk.audio/
36 stars 6 forks source link

Discrepancy in dir name between 'getting started' and 'elk-examples' #2

Open GeospatialDaryl opened 4 years ago

GeospatialDaryl commented 4 years ago

The io.github tutorial at elk-docs references a directory: mda-vst3.vst3:

First unpack the tar-file with the plugin to your local drive. Place the content in the default path expected: /usr/lib/VST3/mda-vst3.vst3. If you place the mda-vst3.vst3 extracted content elsewhere, you also need to edit the config_play_vst3.json to refer to that new path.

A git clone of examples has a directory named mda-vst3-vst3, not mda-vst3.vst3. A simple fix, but it took me a cycle.

Should this have been a PR on elk-docs?

IliasBergstrom commented 4 years ago

Hi!

Due to the holidays our reply may be a bit late, sorry about that. Taking a look at the content of the .tar.xz file linked, the content to me seems to correspond correctly with what is mentioned in the documentation, and the config_play_vst3.json file too.

Due to the wording of the instructions, it is possible to conflate the content of the 'mda_jx10_vst3' folder in the elk-examples repository (which is text files only, no binaries), with the binary content of the 'mda-vst3.vst3.tar.xz' file. Unless I am mistaken, it seems to me that the issue you raise is a consequence of that, no?

In any case, I have now updated the wording in the instructions you mention, to clarify that the content referred to is that of the .tar.xz file, containing the desktop plugin binary.

Let us know if I misunderstood your suggestion.

Best, Ilias B.