Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename hardware target #9

Merged
merged 1 commit into from
Apr 15, 2020

Conversation

amclain
Copy link
Member

@amclain amclain commented Apr 12, 2020

What do you think about renaming the hardware target to:

  1. keybow
  2. rpi0

My thought behind this is that the Nerves target is the hardware that the firmware is designed to run on. Since Xebow is a firmware modification to the Keybow and does not modify the hardware, I think the target should be named after the hardware.

That being said, there are two major components that could be considered in regards to Xebow's target:

  1. Keybow, which is the entire hardware platform. This includes the RPi0, keys, LEDs, etc.
  2. The RPi0, which is just the embedded processor and doesn't include the peripherals.

Due to this I lean towards keybow as the target, but I could see either being valid. One litmus test could be: "Can Xebow run effectively on a Raspberry Pi without the Keybow perpherials"? I believe the answer is no, which again, draws me more towards keybow rather than rpi0.

Thoughts?

@@ -56,7 +56,7 @@ defmodule Xebow.MixProject do

# Dependencies for specific targets
{:xebow_rpi0,
github: "doughsay/xebow_rpi0", ref: "v1.10.2+xebow.2", runtime: false, targets: :xebow_rpi0}
github: "doughsay/xebow_rpi0", ref: "v1.10.2+xebow.2", runtime: false, targets: :keybow}
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@doughsay I recommend prefixing the Nerves system repo with nerves_system_ to follow the convention that the other Nerves targets do, if you think that's a good idea.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You're definitely right, this makes much more sense. I should rename the system repo to be nerves_system_kebow too.

@doughsay doughsay merged commit e4f96a4 into nerves-keyboard:master Apr 15, 2020
@amclain amclain deleted the rename-hardware-target branch April 17, 2020 04:42
@amclain amclain mentioned this pull request Apr 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants