Skip to content

Commit 3dc0ca0

Browse files
committed
updated dev readme, added more detail to the coordmap setup
1 parent c0ad4e1 commit 3dc0ca0

File tree

2 files changed

+6
-26
lines changed

2 files changed

+6
-26
lines changed

README.md

Lines changed: 1 addition & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ install everything with
2727
then just run it with dev to start
2828
`yarn dev`
2929

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

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

53-
## done
54-
- [x] 1 row / 1col says pin has no len()
55-
- [x] overwrite on first flash
56-
- [x] boot.py generation
57-
- [x] versioning for python files
58-
- [x] direct pin wiring support
59-
- [x] save a backup of the json in electron
60-
- [x] dragging keys on the layout editor
61-
- [x] Layout editor to replace KLE
62-
- [x] save pog.json (use as main storage for everything)
63-
- [x] adjust keymap when matrix changes
64-
- [x] drag and drop keys
65-
66-
## Using Electron
67-
68-
### Install
69-
70-
```bash
71-
$ npm install
72-
```
73-
74-
### Development
75-
76-
```bash
77-
$ npm run dev
78-
```
7954

8055
### Build
8156

src/renderer/src/components/CoordMap.vue

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,11 @@
3333
If nothing is happening first replug the board in case it hasnt started and wait 5 seconds.
3434
If this did not help check the diode direction or pins.
3535
</p>
36+
<p class="py-4">
37+
the coordmap should be printed as a list of 3 digit numbers seperated by spaces. eg 001 005 008 002 ... <br/>
38+
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.
39+
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.
40+
</p>
3641
<textarea
3742
id="keycapture"
3843
v-model="coordmap"

0 commit comments

Comments
 (0)