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

https://github.com/quchen/ergodox

Fire-and-forget build system for configuring my Infinity Ergodox
https://github.com/quchen/ergodox

Last synced: over 1 year ago
JSON representation

Fire-and-forget build system for configuring my Infinity Ergodox

Awesome Lists containing this project

README

          

ErgoDox build system
====================

Fire-and-forget build system for configuring the [Infinity Ergodox][dox].

Usage
-----

### Installation

1. Clone this repo
2. [Install Stack][stack-install]
3. Install prerequisite packages

```bash
sudo apt-get install \
cmake \
ctags \
libusb-1.0-0-dev \
binutils-arm-none-eabi \
gcc-arm-none-eabi \
dfu-util
```

4. Run `./build` to set up the build system

### Execution

1. Edit layouts in `Layout/` and configure their interplay in
`Layout/Config.hs`
2. Run `./build (left|right)`
- Build with `--flash` to flash the keyboard after building

Directory contents
------------------

- `controller`: Firmware compilation
- `Build`: Build system files
- `Layout`: Key layout configuration
- `build`: Build system entry point
- `README.md`: This file
- `Setup.hs`, `stack.yaml`, `ergodox.cabal`: Haskell auxiliary files

[dox]: http://input.club/devices/infinity-ergodox
[stack-install]: http://docs.haskellstack.org/en/stable/README.html#how-to-install