Relationship with kaleidoscope repo is confusing about model01-firmware HOT 10 OPEN

from model01-firmware.

Good point. I'll give it a try.

from model01-firmware.

This repository is the official default firmware for the Keyboardio Model01. The one in the Kaleidoscope is merely a basic example.

I'd suggest continuing to use this repo as the base of your own modifications.

from model01-firmware.

wow, that was fast!

Okay. I suggest adding some note, perhaps a short README, to the Kaleidoscope example to make this clearer.
BTW, I think that part of my confusion stemmed from the fact that this repo readme instructs users to install & configure arduino using these instructions from kaleidoscope: https://kaleidoscope.readthedocs.io/en/latest/setup_toolchain.html, and it's not fully clear which part is the common setup and which corresponds to using GUI. I wish the instructions were clearer.

PS I've read your blog, good stuff :)

from model01-firmware.

PPS anyway, thank you! :)

from model01-firmware.

I had the same confusion, and actually used the example version from kaleidoscope, which caused me problems (as it is limited, e.g. no Crysalis support), which @algernon helped me overcome in chat (thanks again!)
I would preffer if the kaleidoscope example would be removed alltogether, and just be replaced with a link (or inclusion of this repo as a git submodule).

from model01-firmware.

I'd rather go the other way around: update the example in Kaleidoscope, and declare that the default firmware. We do that for the Keyboardio Atreus and the Model 100, we could do it for the Model01 too.

The reason it wasn't done before is - I believe - historical: with a separate repository, it was easier to iterate on both independently. We no longer need to do that, so may aswell turn this repo into a link.

What do you think, @obra?

from model01-firmware.

I don't think the IDE detects examples in any other place than the top-level examples dir. We could still have it in the hw plugin dir, and just copy it over during package build, like we juggle the plugins/ dir around too.

from model01-firmware.

from model01-firmware.

it should detect the examples for any arduino library, which our plugins are.

I just tried this, and indeed, it works, so we can move the factory firmware files to the plugin dirs.

from model01-firmware.