OELBRD

Custom designed keyboard PCB and Firmware
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started (Keymap setup)
   • Prerequisites
   • Creating a keymap
3. Contributing
4. License
5. Acknowledgments

About The Project

Small project containing the PCB design files (KiCad project) along with the source code for different keymaps for my custom designed 60% keyboard.

(back to top)

Built With

• KiCad
  • https://github.com/egladman/keebs.pretty
  • https://github.com/tmk/keyboard_parts.pretty
• QMK

(back to top)

Getting Started (Keymap setup)

This is an example of how you can create your own keymap for the oelbrd.

Prerequisites

• Text editor of choice
• QMK

Creating a keymap

1. Clone the repo

   git clone https://github.com/oelburk/oelbrd.git

2. Create new folder in keymaps folder

   mkdir QMK/keymaps/my-keymap

3. Copy default keymap (optional)

   cp QMK/keymaps/default/keymap.c QMK/keymaps/my-keymap

4. Edit keymap.c with preferred layout
5. Create oelbrd in QMK

   qmk new-keyboard oelbrd

6. Copy over contents from the QMK folder to new oelbrd directory in QMK repo, usally ../qmk_firmware/keyboards/oelbrd
7. Compile the new keymap using QMK

   qmk compile -kb oelbrd -kb my-keymap

8. Flash new layout

VIA support

There are currently some strange issues with the implemented VIA support, complaining about missing version definitons etc.

To fix this issue:

1. Open qmk_firware/quantum/via.h
2. Replace the define VIA_PROTOCOL_VERSION at row 62

    VIA_PROTOCOL_VERSION 0x0009

3. Re-compile your keymap.
4. Enjoy VIA!

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

• Shoutout othneildrew for nice README template
• Swe Mech Keebs Community

(back to top)