chore(qmkasciigen): update docs
parent
fabcc31a47
commit
f325dc378d
24
README.md
24
README.md
|
@ -103,13 +103,29 @@ Install:
|
||||||
go install github.com/haunt98/qmk_keymaps/cmd/qmkasciigen@latest
|
go install github.com/haunt98/qmk_keymaps/cmd/qmkasciigen@latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Usage:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
# Generate from QMK repo
|
||||||
|
# Keymap must be JSON (exist keymap.json)
|
||||||
|
qmkasciigen -qmk-keyboard ymdk/id75 -qmk-keymap via -out ascii.txt
|
||||||
|
|
||||||
|
# Generate from local keymap.json
|
||||||
|
qmkasciigen -qmk-keyboard dztech/dz60rgb_wkl/v2_1 -qmk-keymap-file dztech_dz60rgb_wkl/keymaps_json/haunt98/keymap.json -out ascii.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
Thanks:
|
||||||
|
|
||||||
|
- [yskoht/keymapviz](https://github.com/yskoht/keymapviz)
|
||||||
|
- [caksoylar/keymap-drawer](https://github.com/caksoylar/keymap-drawer)
|
||||||
|
|
||||||
## TODO
|
## TODO
|
||||||
|
|
||||||
- [x] How to flash
|
- [x] How to flash
|
||||||
- [x] Add stock firmware/docs
|
- [x] Add stock firmware/docs
|
||||||
- [x] Add qmk lint
|
- [x] Add qmk lint
|
||||||
- [x] Visualize
|
- [x] Visualize
|
||||||
- [ ] qmkasciigen
|
- [x] qmkasciigen
|
||||||
- [ ] Use flag
|
- [x] Use flag
|
||||||
- [ ] Add docs
|
- [x] Add docs
|
||||||
- [ ] Get data directly from qmk
|
- [x] Get data directly from qmk
|
||||||
|
|
Loading…
Reference in New Issue