diff --git a/doc/buildguide_v1.md b/doc/buildguide_v1.md index 4b3e3aa..10e7bc7 100644 --- a/doc/buildguide_v1.md +++ b/doc/buildguide_v1.md @@ -116,20 +116,7 @@ Use the cutters to trim any extruding wires on the underside of the PCBs. Maybe Congratulations, you have successfully built your own custom keyboard. -Now you only need to install the firmware and tweak your keymap. -Clone this qmk branch: https://github.com/tompi/qmk_firmware/tree/cheapino - -Open a shell in the folder and get git submodules with -make git-submodules - -Then flash the cheapino with -make cheapino:default:flash - -To tweak the keymap, copy one of the keymaps from keyboards/cheapino/keymaps, -edit it in the [qmk online configurator](https://config.qmk.fm/), and flash it with -make cheapino:yourkeymap:flash - -Tweaking the encoder actions needs to be done in the keyboards/cheapino/encoder.c file. +See the [firmware guide](firmware.md) for how to build and customize keyboard firmware. Send me a mail or issue if something doesnt work as expected! diff --git a/doc/firmware.md b/doc/firmware.md new file mode 100644 index 0000000..7c4a49e --- /dev/null +++ b/doc/firmware.md @@ -0,0 +1,50 @@ +Setting up and compiling qmk +============================ + +Unfortunately, the cheapino firmware is not merged into the official qmk repository, +so there are a few extra steps to setting up qmk for compiling cheapino. +This is the recipe for windows(for mac/linux, install qmk the recommended way and jump to step 3): + +1. Install qmk msys from https://msys.qmk.fm/ +2. Inside qmk msys, type qmk setup - this will create a qmk_firmware folder that has cloned the main branch of qmk from git. +3. Run this command to add a reference to the cheapino qmk fork: +```sh +git remote add tompi https://github.com/tompi/qmk_firmware.. +``` +4. Run this command to actually fetch the code(replace "cheapino" with "cheapinov2" if you are using cheapino v2 pcbs): +```sh +git fetch tompi cheapino +``` +5. Run this command to switch local files to the cheapino variant(again, replace "cheapino" with "chepinov2" if using v2 pcbs): +```sh +git checkout tompi/cheapino +``` +6.Now you should be able to make and flash with: +```sh +qmk flash -kb cheapino -km default +``` +7. When qmk says "Waiting for drive to deploy", hold boot btn while pressing reset on the rp2040, which should put it in dfu mode, and qmk will then flash. + +To make your own version and customize it: + +1. Copy the "keyboards/cheapino/keymaps/default/" folder to "keyboards/cheapino/keymaps/thebestkeymap/". +2. Upload the file keymap.json (that you copied) to https://config.qmk.fm/ +3. Go wild with configuring up to 15 layers... +4. Press the download button. +5. Move the downloaded json file to "keyboards/cheapino/keymaps/thebestkeymap/keymap.json" +6. Build and flash the keymap with: +```sh +qmk flash -kb cheapino -km thebestkeymap +``` +7. When qmk says "Waiting for drive to deploy", hold boot btn while pressing reset on the rp2040, which should put it in dfu mode, and qmk will then flash. + +(and you guessed it, you can choose to call it something else than thebestkeymap) + +To help learn your keymap, @omark96 made this tool that works on windows: https://github.com/omark96/qmk_keymap_overlay + +Tweaking the encoder actions needs to be done in the keyboards/cheapino/encoder.c file. +(you dont HAVE to be a progammer to change it, but you may call yourself a novice programmer once you do...) + +Once you change the encoder file, run the command from step 6 and 7 to deploy changes to your keyboard. + +Good luck! diff --git a/case.jpeg b/images/case.jpeg similarity index 100% rename from case.jpeg rename to images/case.jpeg diff --git a/cheapino.jpg b/images/cheapino.jpg similarity index 100% rename from cheapino.jpg rename to images/cheapino.jpg diff --git a/cheapino_pcb.jpg b/images/cheapino_pcb.jpg similarity index 100% rename from cheapino_pcb.jpg rename to images/cheapino_pcb.jpg diff --git a/otherbuild.jpeg b/images/otherbuild.jpeg similarity index 100% rename from otherbuild.jpeg rename to images/otherbuild.jpeg diff --git a/images/otherbuild10.jpeg b/images/otherbuild10.jpeg new file mode 100644 index 0000000..07980a3 Binary files /dev/null and b/images/otherbuild10.jpeg differ diff --git a/images/otherbuild11.jpeg b/images/otherbuild11.jpeg new file mode 100644 index 0000000..ed1863c Binary files /dev/null and b/images/otherbuild11.jpeg differ diff --git a/otherbuild2.jpeg b/images/otherbuild2.jpeg similarity index 100% rename from otherbuild2.jpeg rename to images/otherbuild2.jpeg diff --git a/otherbuild3.jpeg b/images/otherbuild3.jpeg similarity index 100% rename from otherbuild3.jpeg rename to images/otherbuild3.jpeg diff --git a/otherbuild4.jpeg b/images/otherbuild4.jpeg similarity index 100% rename from otherbuild4.jpeg rename to images/otherbuild4.jpeg diff --git a/otherbuild5.jpeg b/images/otherbuild5.jpeg similarity index 100% rename from otherbuild5.jpeg rename to images/otherbuild5.jpeg diff --git a/otherbuild6.jpeg b/images/otherbuild6.jpeg similarity index 100% rename from otherbuild6.jpeg rename to images/otherbuild6.jpeg diff --git a/otherbuild7.jpeg b/images/otherbuild7.jpeg similarity index 100% rename from otherbuild7.jpeg rename to images/otherbuild7.jpeg diff --git a/images/otherbuild8.jpeg b/images/otherbuild8.jpeg new file mode 100644 index 0000000..a48d51a Binary files /dev/null and b/images/otherbuild8.jpeg differ diff --git a/images/otherbuild9.jpeg b/images/otherbuild9.jpeg new file mode 100644 index 0000000..970165e Binary files /dev/null and b/images/otherbuild9.jpeg differ diff --git a/readme.md b/readme.md index b2acea1..1ef3d8a 100644 --- a/readme.md +++ b/readme.md @@ -3,7 +3,7 @@ Cheapino Probably one of the cheapest split keyboards you can build. -![Cheapino with Iceberg keycaps](cheapino.jpg "Ceapino") +![Cheapino with Iceberg keycaps](images/cheapino.jpg "Cheapino") This is the result of really enjoying building keyboards, but not wanting to spend that much money on it. @@ -14,6 +14,8 @@ support 18 switches and an encoder on the right side). Checkout the [build guide](doc/buildguide_v1.md) for more details and pictures. +See the [firmware guide](doc/firmware.md) for how to build and customize keyboard firmware. + If you just want to flash [Miryoku](https://github.com/manna-harbour/miryoku) on your Cheapino, download the [uf2 file from the release section](https://github.com/tompi/cheapino/releases/download/v1.0/cheapino_manna-harbour_miryoku.uf2), put the rp2040-zero in dfu mode by holding boot while pressing reset, then return, @@ -27,32 +29,46 @@ My son is also using his at his work and claims its very usable. These are a few other people that built it: +![Cheapino by finex](images/otherbuild8.jpeg) + https://www.reddit.com/r/ErgoMechKeyboards/comments/12xg4u7/built_the_cheapino/ -![Cheapino by TentacleSenpai69](otherbuild.jpeg) +![Cheapino by TentacleSenpai69](images/otherbuild.jpeg) https://www.reddit.com/r/ErgoMechKeyboards/comments/13c274r/cheapino_build/ -![Cheapino by Palbi](otherbuild2.jpeg) +![Cheapino by Palbi](images/otherbuild2.jpeg) https://discuss.tchncs.de/post/410101 -![Cheapino by PixelPrimer](otherbuild3.jpeg) +![Cheapino by PixelPrimer](images/otherbuild3.jpeg) https://discuss.tchncs.de/post/852362 -![Cheapino by Chraccoon](otherbuild4.jpeg) +![Cheapino by Chraccoon](images/otherbuild4.jpeg) https://lemmy.world/post/2080485 -![Cheapino by Hansamann](otherbuild5.jpeg) +![Cheapino by Hansamann](images/otherbuild5.jpeg) https://lemmy.world/post/2832967 -![Cheapino by createkarma](otherbuild6.jpeg) +![Cheapino by createkarma](images/otherbuild6.jpeg) + +![Cheapino by ??](images/otherbuild7.jpeg) + +https://www.reddit.com/r/ErgoMechKeyboards/comments/18i5jpu/first_build_cheapino/ +![Cheapino by lydomixian](images/otherbuild9.jpeg) + +https://www.reddit.com/r/ErgoMechKeyboards/comments/18zb3l1/first_build_finally_cheapino/ +![Cheapino by u/Tech-Buffoon](images/otherbuild10.jpeg) -![Cheapino by ??](otherbuild7.jpeg) https://lemmy.world/post/2480447 -![Case by Chraccoon](case.jpeg) +![Case by Chraccoon](images/case.jpeg) Printable file for the case here: https://www.printables.com/model/541536-cheapino-case-with-basic-tenting +Probably the cheapest tenting solution: https://www.reddit.com/r/ErgoMechKeyboards/comments/16s3yb2/cheapino/ +![Cheapino by @JordanNiphan](images/otherbuild11.jpeg) + @keyboard-magpie made a plate which will help position the switches: [plate.stl](plate.stl) +@ggppjj made some useful modifications to miryoku and enabled LED for that as well here: https://github.com/ggppjj/qmk_firmware/releases + Drawbacks: * Without a plate, its pretty difficult to solder swithes straight. I made a small helper "fork" to hold each column in place when soldering. @@ -60,4 +76,4 @@ Drawbacks: * There is no official qmk support, you need to compile from my branch manually... Keymap can be edited in qmk configurator though. -![Cheapino PCB](cheapino_pcb.jpg "Cheapino PCB") +![Cheapino PCB](images/cheapino_pcb.jpg "Cheapino PCB")