Skip to content

Commit

Permalink
Update readme and add some images. #48
Browse files Browse the repository at this point in the history
  • Loading branch information
karliss committed Oct 8, 2023
1 parent 2f2e3b0 commit 14174a8
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,25 @@ Tool for editing layouts of custom keyboards. Try it [here](https://karliss.gith

It is intended for keeping track of mapping between physical layout, logical layout, wiring matrix and scanning matrix and generating configuration files from this information.

[image physical layout edit](docs/images/readmed_p.png)
[image wiring edit](docs/images/readmed_w.png)

## Project status

Early development - most features unusable.
Early development - not exactly end user robust, but has enough functionality to be useful for my personal use

* Physical layout definition - mostly working
* Logical layout mapping - done
* Wiring and scan matrix - done
* Importers - mostly working
* Exporters - missing
* Exporters - helps dealing with most tedious parts related to keys, rest of the config my need manual editing
- QMK info.json matrix pins, layout (positions and matrix)
- KLE - basic position, size, label (no advanced styling features)
- QMK layout macro -> pretty prints taking into account key width. Somewhat redundant due to QMK data driven configuration.
- QMK keymap.json template -> some fancy formating, for manual editing. No wey to define the content of keymap.
- VIA json -> VIA specific values need to be filled in manually after exporting
* Key mapping configuration - missing, low priority due to plenty of existing tools doing that


## Comparison with other tools

* keyboard-layout-editor.com - Focuses on keyboard visual properties. Usefull when desigining look or planning what keycaps to order. Such functionality is currently out of scope for kb-editor. keyboard-layout-editor has almost no function related to configuring keyboard firwmare.
Expand Down
Binary file added docs/images/readme_w.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/readmed_p.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 14174a8

Please sign in to comment.