Skip to content

Strip QMK and Userspace keyboard readme's #24

Description

@bstiq

Topic of discussion re:our qmk userspace:

currently the info about each specific keyboard + pictures of its keymaps are in:

  • the readme of the keyboard in our QMK userspace
  • the readme of the keyboard in the main QMK repository
  • scattered in various parts of the docs - in bkb keymaps and charybdis firmware

and those 3 are essentially duplicates, so harder to manage and harder to find info.

upstream QMK readmes can be stripped - most of the stuff there never seemed to help anyone who couldn't already navigate the folder structure and read the code itself to begin with

TODO:

  • strip the readme of the keyboard in our QMK userspace
  • strip the readme of the keyboard in our QMK repository
  • push changes to the main QMK repo
  • update the charybdis docs
  • update the dilemma docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions