Skip to content

Commit

Permalink
updated dev readme, added more detail to the coordmap setup
Browse files Browse the repository at this point in the history
  • Loading branch information
JanLunge committed Dec 16, 2024
1 parent c0ad4e1 commit 3dc0ca0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 26 deletions.
27 changes: 1 addition & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ install everything with
then just run it with dev to start
`yarn dev`

to release a new version use `npm version minor` or `major` or `patch` then just push and github actions will do the rest

# Tasks
## bugs
Expand All @@ -50,32 +51,6 @@ then just run it with dev to start
- [ ] way to handle differences between pog.json to kmk code
- [ ] wiring preview

## done
- [x] 1 row / 1col says pin has no len()
- [x] overwrite on first flash
- [x] boot.py generation
- [x] versioning for python files
- [x] direct pin wiring support
- [x] save a backup of the json in electron
- [x] dragging keys on the layout editor
- [x] Layout editor to replace KLE
- [x] save pog.json (use as main storage for everything)
- [x] adjust keymap when matrix changes
- [x] drag and drop keys

## Using Electron

### Install

```bash
$ npm install
```

### Development

```bash
$ npm run dev
```

### Build

Expand Down
5 changes: 5 additions & 0 deletions src/renderer/src/components/CoordMap.vue
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@
If nothing is happening first replug the board in case it hasnt started and wait 5 seconds.
If this did not help check the diode direction or pins.
</p>
<p class="py-4">
the coordmap should be printed as a list of 3 digit numbers seperated by spaces. eg 001 005 008 002 ... <br/>
it will print this via a hotkey on the number row so make sure to switch to something like qwerty if you are using azerty or another layout that mapps other keys to the number row.
for split keyboards try the coordmap with the type set to normal as depending on the split side detection the secondary half might not output to usb.
</p>
<textarea
id="keycapture"
v-model="coordmap"
Expand Down

0 comments on commit 3dc0ca0

Please sign in to comment.