Document how to use the Arduino IDE with git master

[algernon]

Way back when, it was possible to clone the Kaleidoscope-Bundle-Keyboardio repository into ~/Arduino/hardware/keyboardio, and work with that, as is, with Kaleidoscope being under avr/libraries/Kaleidoscope. I could symlink that to another place to make it easier to work with it, but it still worked as-is.

Nowadays, we need to move plugins/ to a place where Arduino can find them. That's done by the bin/build-arduino-package script, but that does a whole lot of other things too.

It would be great to have some official documentation - and perhaps a shorter script than build-arduino-package - to help set things up.

[obra]

It's not currently possible to git clone Kaleidoscope and have it usable in the Arduino IDE. That's why we're publishing packages on every commit. https://github.com/keyboardio/arduino-kaleidoscope-master

This is actually documented in our "how to set up the Arduino IDE" docs at https://kaleidoscope.readthedocs.io/en/latest/setup_toolchain.html

On Mon, May 30, 2022 at 4:24 PM Gergely Nagy @.***> wrote:

Way back when, it was possible to clone the Kaleidoscope-Bundle-Keyboardio https://github.com/keyboardio/Kaleidoscope-Bundle-Keyboardio repository into ~/Arduino/hardware/keyboardio, and work with that, as is, with Kaleidoscope being under avr/libraries/Kaleidoscope. I could symlink that to another place to make it easier to work with it, but it still worked as-is.

Nowadays, we need to move plugins/ to a place where Arduino can find them. That's done by the bin/build-arduino-package script, but that does a whole lot of other things too.

It would be great to have some official documentation - and perhaps a shorter script than build-arduino-package - to help set things up.

— Reply to this email directly, view it on GitHub https://github.com/keyboardio/Kaleidoscope/issues/1190, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAALC2AGVTW2BLLQVGTUA3DVMVE2DANCNFSM5XLY3QYQ . You are receiving this because you are subscribed to this thread.Message ID: @.***>

[algernon]

Yeah, I read those docs. They're great when someone wants to use the latest Kaleidoscope. It's not very helpful when someone wants to develop Kaleidoscope, and still use the IDE, to make sure things work in that environment too.

From the commandline, this is no problem, because we can just pass --libraries "${KALEIDOSCOPE_DIR}/plugins/ to arduino-cli, and all is well. That doesn't work for the IDE, we need to do a symlink farm, or copy things over. That's the part we should automate, in my opinion.