Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some clearer explanations in README #95

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Some clearer explanations in README #95

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
53325ee
Clearer documentation of the -r option
hupfdule Jul 1, 2023
c4f82a9
Clearer documentation of JSON file generation
hupfdule Jul 1, 2023
43ffa35
Document -h option
hupfdule Jul 1, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,10 @@ $ keymapviz qmk_firmware/keyboards/lets_split/keymaps/default/keymap.c -c /path/

An example file is provided in the root of this project, named `config.properties`.

Output json file.
This json file can be used in [http://www.keyboard-layout-editor.com/](http://www.keyboard-layout-editor.com/).
### Output json file

A json file can be generated that can be used in [http://www.keyboard-layout-editor.com/](http://www.keyboard-layout-editor.com/)
to visualize keymap. However, keymapviz will always generate one json file per layer.

```sh
$ keymapviz qmk_firmware/keyboards/lets_split/keymaps/default/keymap.c -t json -o 'lets_split{}.json'
Expand Down Expand Up @@ -178,12 +180,26 @@ $ keymapviz -t fancy qmk_firmware/keyboards/kbdclack/kaishi65/keymaps/default/ke

### Replace ascii-art in keymap.c

Generate backup as keymap.c.bac
The generated ascii-art can be written directly into the source code file with the option `-r`.

For each keymap a comment block containing the string `[keymapviz]` needs to be
added to the source code. That block will then be replaced with the result of
the current run.

A backup file of the source file will be created with the suffix `.bac`.

```sh
$ keymapviz -r keymap.c
```

### Usage help

To get a list of all options and all supported layouts call keymapviz with the `-h` option.

```sh
$ keymapviz -h
```

## Contributing

Please see [CONTRIBUTING.md](./CONTRIBUTING.md).
Expand Down