start work on qmk user keymaps

This commit is contained in:
kemonine 2022-01-21 21:03:57 -05:00
parent 1ccd0910c3
commit d6c4e05cf9
3 changed files with 62 additions and 0 deletions

1
qmk/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
.build/

58
qmk/README.md Normal file
View File

@ -0,0 +1,58 @@
# QMK Notes
## Inspiration
- https://git.sr.ht/~sungo/qmk_userspace/tree/main
## Compiling
``` sh
qmk compile -kb tidbit -km kemonine
```
## Docker Critical
### Docker Run
``` sh
# PowerShell
# Use ` instead of \
# Use ${PWD} instead of $(pwd)
docker run --rm -it \
-v qmk_firmware:/qmk_firmware \
-v ${PWD}/.build:/qmk_firmware/.build \
-v ${PWD}/kemonine:/qmk_firmware/users/kemonine \
qmkfm/qmk_cli /bin/bash
```
### Update / Clone Sources
``` sh
# PowerShell
# Use ` instead of \
docker run --rm -it `
-v qmk_firmware:/qmk_firmware \
qmkfm/qmk_cli /bin/bash
cd /qmk_firmware
if [ -d .git ];
then
git pull;
else
git clone https://github.com/qmk/qmk_firmware.git .;
fi
```
### Docker Volumes
#### QMK Sources
`qmkfm/qmk_cli` lacks sources. Use named volume to speed dev and output
#### KemoNine
Need to have the `qmk/users/kemonine` directory mounted at `/qmk_firmware/users/kemonine` in Docker container
#### Build output
Need to have a local dir for build artifact extraction at `/qmk_firmware/.build`

View File

@ -0,0 +1,3 @@
# KemoNine's QMK Code
See title