Update readme for latest repo organization

This commit is contained in:
kemonine 2020-09-24 23:28:14 -04:00
parent 947a1a88a8
commit 95c07eee8b

View file

@ -1,25 +1,27 @@
# mdloader
# Keyboards
A fork of the main [mdloader](https://github.com/Massdrop/mdloader) repo that has some tweaks so users can re-build ```mdloader``` with the proper chip id of their keyboard.
Various sources and information on how KemoNine has setup their keyboards and macro pads.
## Organization
- The ```firmware``` folder has pre-compiled firmware as well as screen shots of the board layout
- The ```src_mdloader``` folder has a copy of the ```mdloader 1.0.3``` release
- The ```mdloader``` folder has a copy of the ```mdloader 1.0.3``` release that's been patched to work with more keyboard chip ids than massdrop provides
- The ```keyboards``` folder has KemoNine's keyboard/macro pad setups
## Source Tweaks
- This code has had the following chip id's added so others don't have to add them
- The ```qmk``` sources have KemoNine's massdrop alt configuration/keymap
- The ```mdloader``` code has had the following chip id's added so others don't have to add them
- ```0x60060006```
- ```0x60060305```
- ```0x60060306```
- ```0x60060005```
## Using
## Using mdloader
To work with this repo build and run the ```mdloader``` tool with ```--list```. I have patched the code to show *all* of the chip ids for boards found. Once you have the chip id, edit ```mdloader_common.c``` and change the chip id as necessary. Rebuild the tool and run per the standard documentation.
To work with this repo's fork of mdloader, build and run the ```mdloader``` tool with ```--list```. I have patched the code to show *all* of the chip ids for boards found. Once you have the chip id, edit ```mdloader_common.c``` and change the chip id as necessary. Rebuild the tool and run per the standard documentation.
# Licensing
## Licensing
Unless otherwise stated all source code is licensed under the [Apache 2 License](LICENSE-APACHE-2.0.txt).