Rename /examples to /firmware

[mepholic]

This fixes a minor pet peeve of mine regarding the name of the directory that the firmware entry points reside in.

Now that the project has matured and made a name for itself, maybe it's time to move the firmware types into a more aptly named directory?

firmware/ seems like a good name, since it includes firmware which runs meshcore clients and repeaters, along with other meshcore and lora firmware spins

[awhite2000]

I agree, examples/ doesn't do it justice when it contains the fundamental implementations needed for running the mesh. firmware/ would be better, I think of these as apps/.

[ViezeVingertjes]

• I dunno suggest something else!

'MeCoShRe' 💯

apps would be fine i think; although it could use a cleanup. SecureChat firmware has been broken for ages and is still in there, Sensor firmware is a proper example(?) and room server has been harming many meshes to date because it did not get the attention it needs lately.

[mepholic]

• I dunno suggest something else!

'MeCoShRe' 💯

apps would be fine i think; although it could use a cleanup. SecureChat firmware has been broken for ages and is still in there, Sensor firmware is a proper example(?) and room server has been harming many meshes to date because it did not get the attention it needs lately.

I took your suggestion here, and applied it across the entire repo off the latest dev, then squashed the commits in the branch down to a single commit that should be ready to ship. Let's see if CI passes...

I think apps is more apt, since it's not just Meshcore in there now, with the KISS modem and all. That's a meshcore facilitator but not meshcore itself.

[liamcottle]

Howdy!

I personally would have gone with /firmware, since everyone knows you flash the firmware to your node, and each folder in there is a different firmware type.

Calling it /apps might confuse users thinking it's the mobile apps or something...

Would be nice to rename, but this would also break most existing PRs.

You'd have to convince @ripplebiz if you want this renamed, I won't be willing to merge without his approval on it.

[mepholic]

I'm happy to change this to firmware too, it's simple enough! I'd be interested in @ripplebiz's input, and will wait on it before making any further changes.

[mepholic]

there were suggestions to:

• move this to src/firmware - che
• refactor other parts of the codebase such as
  • "tbh, would be nice for /src/firmware, /src/drivers etc" - liam
  • "a bunch of the display drivers should prob move from src/helpers/ui/ST7789Display to src/drivers/display/..." - liam

I'm happy to take che's suggestion in this PR, and like Liam's idea of moving drivers into a more aptly named directory within src/, but believe this should be separately scoped. If this gets merged, I'll work on the driver split/move next.

[ripplebiz]

Howdy!

I personally would have gone with /firmware, since everyone knows you flash the firmware to your node, and each folder in there is a different firmware type.

Calling it /apps might confuse users thinking it's the mobile apps or something...

Would be nice to rename, but this would also break most existing PRs.

You'd have to convince @ripplebiz if you want this renamed, I won't be willing to merge without his approval on it.

Sure, rename to /firmware

[mepholic]

@ripplebiz I've updated it on your request. I can squash it if you like, just lemme know!

Thank you!