README.md

RMK - a Rust Keyboard Firmware ⌨️

Originally made for the Quanta keyboard.

----- 🏗️ THIS IS A WORK IN PROGRESS 🚧 -----

Table Of Contents 📑

• 📖 Docs
  • ▶️ Getting started
    • yes
• 🔡 Details
  • 📝 Authors and Contributors
    • Author
    • Contributors
  • 🌟 Acknowledgements
  • 🧑‍🤝‍🧑 Contributing
  • ®️ License

📖 Docs

https://rmk.obsilab.com

▶️ Getting started

yes :

WIP

Keymap

Make a keymap.json file manually, based on example_keymap.json.

{
  "name": "Example Keymap",
  "version": 1.0,
  "author": "RMK",
  "layers": 2,
  "max_rows": 3,
  "max_columns": 3,
  "description": "Experimental. An example keymap for RMK firmware, 3x3 key matrix with two layers.",
	"layer1": {
		"row1": ["KEY_Q", "KEY_W", "KEY_E"],
		"row2": ["KEY_A", "KEY_S", "KEY_D"],
		"row3": ["KEY_null", "KEY_null", "KEY_null"]
	},
	"layer2": {
		"row1": ["KEY_TRNS", "KEY_T", "KEY_MEDIA_PLAY_PAUSE"]
	}
}

Or use RMK GUI Configurator (RGC) (WIP).

---

🔡 Details

📝 Authors and Contributors

Author :

• Lucas Placentino

Contributors :

• List of contributors

🌟 Acknowledgements

💡 Inspired by QMK and KMK.

🧱 Based off of:

• https://github.com/Innectic/rmk
• https://github.com/rp-rs/rp-hal
• https://github.com/dlkj/usbd-human-interface-device
• https://github.com/TeXitoi/keyberon
• https://github.com/camrbuss/pinci
• https://github.com/ChrisChrisLoLo/keezyboost40/tree/master/firmware/keezus

🧑‍🤝‍🧑 Contributing

...

®️ License

Licensed under an MIT License

---

↑ Go To TOP