STKAudioKit icon indicating copy to clipboard operation
STKAudioKit copied to clipboard

Update README with more instructions

Open sridharrajagopal opened this issue 2 years ago • 3 comments

Description

Hi there,

I've opened the demo workspace in Xcode and built and successfully deployed it to the simulator (ios and macos).

However, it is not clear how exactly I can get the playground working. Opening the playground file in Xcode gives an error that "no such module exists" in import AudioKit .

Opening the demo workspace only shows the demo code, not the playground.

It would be great if the README could be updated with just a little more information on simple steps to get started with both the demo and the playground. It would go a great way into letting a new user get started easily.

Thanks, Sridhar

Proposed Solution

It would be great if the README could be updated with just a little more information on simple steps to get started with both the demo and the playground. It would go a great way into letting a new user get started easily.

Describe Alternatives You've Considered

I've looked at other sources for adding swift packages to a standalone playground.

I've also looked at creating a new workspace and a new playground and then just copying/pasting the code. However, everything is there in this repository, so one should be able to just get started - a little more in the way of instructions would go a long way towards that.

Additional Context

No response

sridharrajagopal avatar Jun 11 '23 19:06 sridharrajagopal

I did manage to find the playground in the Demo App Workspace - called STKAudioKit.

This time, since it was within the scope of the workspace, it no longer complained about finding "import AudioKit"

However, the Clarinet playground fails with the following error messages:

expression failed to parse: error: Clarinet.xcplaygroundpage:10:16: error: cannot find 'Clarinet' in scope let clarinet = Clarinet() ^~~~~~~~

error: Clarinet.xcplaygroundpage:12:14: error: cannot find 'Reverb' in scope let reverb = Reverb(clarinet) ^~~~~~

error: Clarinet.xcplaygroundpage:16:14: error: cannot find 'AudioEngine' in scope let engine = AudioEngine() ^~~~~~~~~~~

error: Clarinet.xcplaygroundpage:24:37: error: cannot find 'Log' in scope if !scale.contains(note % 12) { Log("ACCIDENT!") } ^~~

error: Clarinet.xcplaygroundpage:27:32: error: cannot find 'MIDINoteNumber' in scope clarinet.trigger(note: MIDINoteNumber(note + octave), velocity: 127) ^~~~~~~~~~~~~~

sridharrajagopal avatar Jun 12 '23 00:06 sridharrajagopal

Clearly, I'm not doing things "just right". Some instructions would make the onboarding a lot smoother.

Thanks, Sridhar

sridharrajagopal avatar Jun 12 '23 00:06 sridharrajagopal

I did manage to get the Clarinet example working in my setup - but not from the playground on the github code.

Thanks, Sridhar

sridharrajagopal avatar Jun 12 '23 03:06 sridharrajagopal