EcoSteno-Firmware/README.md

Ecosteno Custom Keymaps

This repository contains the custom keymaps for the Ecosteno keyboard. It also contains the guide on how to set up the keymaps.

Table of Contents

• Ecosteno Custom Keymaps
• Table of Contents
• Related Articles
• Pre-requisites
• Clone Repository
• Set Up QMK Environment
  • 1. Prepare Build Environment
  • 2. Run QMK Setup
  • 3. Copy the keyboard to the QMK directory
  • 4. Test Build Environment
• Remapping Keys
  • 1. Edit the Keymap File
  • 2. Copy the Keymap to the QMK Directory
  • 3. Compile the Keymap
• Flashing the Keyboard

Related Articles

• QMK Firmware Guide

Pre-requisites

• EcoSteno Keyboard
• MacOS
• Homebrew
• EcoSteno Firmware

Clone Repository

git clone git@github.com:afiqzudinhadi/EcoSteno-Firmware.git

Set Up QMK Environment

1. Prepare Build Environment

brew install qmk/qmk/qmk

2. Run QMK Setup

qmk setup

Answer 'Y' to all the prompts.

3. Copy the keyboard to the QMK directory

cp -r keyboards/* ~/qmk_firmware/keyboards/

4. Test Build Environment

qmk compile -kb noll/ecosteno -km default

Remapping Keys

1. Edit the Keymap File

Keymaps are located in the following directory:

keyboards/noll/ecosteno/keymaps/default/keymap.c

Keymap guide can be found here.

2. Copy the Keymap to the QMK Directory

If keymap file is edited, copy the keymap to the QMK directory:

cp -r keyboards/* ~/qmk_firmware/keyboards/

3. Compile the Keymap

qmk compile -kb noll/ecosteno -km default

Flashing the Keyboard

1. Plug in the keyboard to the computer.
2. Press the reset button on the back of the keyboard near the USB port.
   1. LEDs on the keyboard will turn off.
3. Run the following command to flash the keyboard:

qmk flash -kb noll/ecosteno -km default

4. The keyboard will restart and the new keymap will be loaded.
   1. LEDs on the keyboard will turn on.