An open API service indexing awesome lists of open source software.

https://github.com/zephraph/keyboard


https://github.com/zephraph/keyboard

Last synced: about 1 year ago
JSON representation

Awesome Lists containing this project

README

          

# Zephraph's Custom Mechanical Keyboard

This is an aspirational project. I'm setting out to build a custom mechanical split keyboard powered by a raspberry pi 0 and Elixir Nerves.

## Targets

Nerves applications produce images for hardware targets based on the
`MIX_TARGET` environment variable. If `MIX_TARGET` is unset, `mix` builds an
image that runs on the host (e.g., your laptop). This is useful for executing
logic tests, running utilities, and debugging. Other targets are represented by
a short name like `rpi3` that maps to a Nerves system image for that platform.
All of this logic is in the generated `mix.exs` and may be customized. For more
information about targets see:

https://hexdocs.pm/nerves/targets.html#content

---

**Note**: I've removed all targets except for `rpi0` as that's the intended development surface area of this platform. I may need to re-add x86 if there's something that needs to be ran locally.

## Getting Started

To start your Nerves app:

- `export MIX_TARGET=rpi0` or prefix every command with
`MIX_TARGET=rpi0`.
- Install dependencies with `mix deps.get`
- Create firmware with `mix firmware`
- Burn to an SD card with `mix firmware.burn`

## Learn more

- Official docs: https://hexdocs.pm/nerves/getting-started.html
- Official website: https://nerves-project.org/
- Forum: https://elixirforum.com/c/nerves-forum
- Discussion Slack elixir-lang #nerves ([Invite](https://elixir-slackin.herokuapp.com/))
- Source: https://github.com/nerves-project/nerves