Giter Club home page Giter Club logo

uwu30-zmk-config's Introduction

uwu30 ZMK Config

Instructions

Brand new to ZMK?

  1. You will need to sign up for a GitHub account, and fork this repository so you can edit it.
  2. Navigate to the Actions tab and click the "I understand my workflows, go ahead and run them" button to enable builds. Actions tab with "I understand my workflows" button
  3. Edit config/uwu30.conf to add/enable/disable features. Edit config/uwu30.keymap to change the keymap.
  4. After committing your changes, your firmware will begin compiling. Assuming there are no typos or other problems, it will eventually be downloadable from the Actions tab.
  5. Flash the non-settings-reset firmware.

Do you have a zmk-config repo already?

You can add this repository as a module by modifying your config/west.yml file.

manifest:
  remotes:
    - name: zmkfirmware
      url-base: https://github.com/zmkfirmware
    # Add the base GitHub URL as a remote.
    - name: ojthetiny # You can name this whatever you like; just make sure the "remote" below matches.
      url-base: https://github.com/ojthetiny
  projects:
    - name: zmk
      remote: zmkfirmware
      revision: main
      import: app/west.yml
    # Add the name of the repository as a project.
    - name: zmk-config
      remote: ojthetiny
      revision: master # This is the name of the branch you want to use.
  self:
    path: config

After making this change, add a copy of the configuration file and the keymap to the config folder that is already in your repo.

Common Questions/Problems

There was an error and the build didn't finish.

There is probably an error in your keymap.

Carefully double-check the last changes you made. Each ZMK code is generally preceded by a reference categorizing what that code does. For example: the letter "Z" is categorized as a key press. To add the letter "Z" to a keymap, it must be written &kp Z. Don't forget to read the ZMK docs!

Clicking into the details of the action will show the error log. While very long, this log will often show the exact line number causing the problem in your keymap so it is worth reading closely.

nickcoutsos's in-browser keymap editor aims to provide a GUI for remapping, which may be helpful.

I edited the keymap/configuration and flashed, but nothing was updated.

Make sure you are editing the files in the config folder.

Changes made in the boards/arm folder will be overridden or ignored; your customizations belong in config.

After disconnecting the keyboard from Bluetooth, it won't reconnect.

Forget the Bluetooth connection on both the uwu30 and the host, then try re-pairing.

If you don't remember which profile on the keyboard was used, you may have to clear them all. See ZMK's documentation for more details on profile management.

As a last resort, try flashing the settings_reset firmware; this will force-clear everything.

Further Troubleshooting Resources

uwu30-zmk-config's People

Contributors

ojthetiny avatar lesshonor avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.