Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create KPrepublic directory #5206

Closed
wants to merge 13 commits into from
Prev Previous commit
Next Next commit
Update make command in kprepublic readme files
  • Loading branch information
zvecr committed Mar 1, 2019
commit 036778268b77ce42ae553af8a8783089d2528b27
7 changes: 4 additions & 3 deletions keyboards/kprepublic/cospad/readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
COSPAD
===
# COSPAD

![COSPAD](https://ae01.alicdn.com/kf/HTB1.lwARFXXXXcKXXXXq6xXFXXXK.jpg?size=289297&height=518&width=750&hash=7c5d826f928b91436cb36dca2746b424)

A DIY Keypad Kit sold by KPRepublic, runs TKG natively.

Expand All @@ -16,6 +17,6 @@ Supported Layouts:

Make example for this keyboard (after setting up your build environment):

make cospad:default
make kprepublic/cospad:default

See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
8 changes: 5 additions & 3 deletions keyboards/kprepublic/daisy/readme.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
# Daisy

![Daisy](https://cdn.shopify.com/s/files/1/2711/4238/products/HTB1ahNecamgSKJjSsplq6yICpXaY_1024x1024.jpg?v=1515526190)

A 40% keyboard kit sold by KPRepublic.

Keyboard Maintainer: westfoxtrot (https://github.com/westfoxtrot)
Hardware Supported: Daisy PCB Rev.1, Daisy PCB Rev.2
Hardware Availability: http://tinyurl.com/yc26lq22
Hardware Availability: https://kprepublic.com/collections/daisy-41/products/daisy-40-custom-keyboard-pcb

Make example for this keyboard (after setting up your build environment):

make daisy:default
make kprepublic/daisy:default

See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
zvecr marked this conversation as resolved.
Show resolved Hide resolved

Expand All @@ -21,7 +23,7 @@ A printable picture showing this layout is available here: https://imgur.com/9mS


```
$ make daisy:[default|<name>]
$ make kprepublic/daisy:[default|<name>]
```

# Bootloader
Expand Down
8 changes: 4 additions & 4 deletions keyboards/kprepublic/jj40/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Hardware Availability: [AliExpress](https://www.aliexpress.com/store/product/jj4

Make example for this keyboard (after setting up your build environment):

make jj40:default:program
make kprepublic/jj40:default:program

See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.

Expand Down Expand Up @@ -43,20 +43,20 @@ the bootloader, you'll need Python 2 with PyUSB installed:
$ pip install pyusb
```

If you prefer (or are having issues with a `program` flash), you can just build it (`make jj40:<keymap-name>` and flash the firmware (`.hex` file) directly with
If you prefer (or are having issues with a `program` flash), you can just build it (`make kprepublic/jj40:<keymap-name>` and flash the firmware (`.hex` file) directly with
`bootloadHID` if you boot the board while holding down `Backspace` (`Top Right Key`) to keep it
in the bootloader:

```
$ make jj40
$ make kprepublic/jj40:default
$ bootloadHID -r jj40_default.hex
```

For Windows 10:
Windows sometimes doesn't recognize the jj40. The easiest way of flashing a new layout is probably using [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
1. Go to Windows Device Manager and find the keyboard (plug it in while holding down `Backspace` (`Top Right Key`)). It can be found under Human Interface Devices or under Keyboards.
2. Go to properties and the Details tab to find the hardware ID. You want the VID and the PID (code after the underscore). Plug them into HIDBootFlash and hit Find Device.
3. Use `make jj40:<keymap-name>` to generate the .hex file in the qmk basis folder. Select the .hex file in HIDBootFlash and press Flash Device.
3. Use `make kprepublic/jj40:<keymap-name>` to generate the .hex file in the qmk basis folder. Select the .hex file in HIDBootFlash and press Flash Device.


## Troubleshooting
Expand Down
8 changes: 4 additions & 4 deletions keyboards/kprepublic/jj4x4/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Hardware Availability: [AliExpress](https://www.aliexpress.com/item/jj4x4-jj4X4-

Make example for this keyboard (after setting up your build environment):

make jj4x4:default:program
make kprepublic/jj4x4:default:program

See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.

Expand Down Expand Up @@ -43,20 +43,20 @@ the bootloader, you'll need Python 2 with PyUSB installed:
$ pip install pyusb
```

If you prefer (or are having issues with a `program` flash), you can just build it (`make jj40:<keymap-name>` and flash the firmware (`.hex` file) directly with
If you prefer (or are having issues with a `program` flash), you can just build it (`make kprepublic/jj40:<keymap-name>` and flash the firmware (`.hex` file) directly with
`bootloadHID` if you boot the board while holding down `8` (second from top, second from left, with usb plug is at the top) to keep it
in the bootloader:

```
$ make jj40
$ make kprepublic/jj40:default
$ bootloadHID -r jj4x4_default.hex
```

For Windows 10:
Windows sometimes doesn't recognize the jj4x4. The easiest way of flashing a new layout is probably using [HIDBootFlash](http://vusb.wikidot.com/project:hidbootflash).
1. Go to Windows Device Manager and find the keyboard (plug it in while holding down `8` (second from top, second from left, with usb plug is at the top)). It can be found under Human Interface Devices or under Keyboards.
2. Go to properties and the Details tab to find the hardware ID. You want the VID and the PID (code after the underscore). Plug them into HIDBootFlash and hit Find Device.
3. Use `make jj4x4:<keymap-name>` to generate the .hex file in the qmk basis folder. Select the .hex file in HIDBootFlash and press Flash Device.
3. Use `make kprepublic/jj4x4:<keymap-name>` to generate the .hex file in the qmk basis folder. Select the .hex file in HIDBootFlash and press Flash Device.


## Troubleshooting
Expand Down
18 changes: 9 additions & 9 deletions keyboards/kprepublic/jj50/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
JJ50
==========================
# JJ50

![jj50](https://cdn.shopify.com/s/files/1/2711/4238/products/HTB1xlBMksLJ8KJjy0Fnq6AFDpXar_1024x1024.jpg?v=1515585489)

This is a port of the QMK firmware for boards that are based on the
ps2avrGB firmware, like the [ps2avrGB keyboard](https://www.keyclack.com/product/gb-ps2avrgb/), for use on the JJ50, a preonic-like board.
Expand All @@ -10,18 +11,17 @@ Note that this is a complete replacement for the firmware, so you won't be
using Bootmapper Client to change any keyboard settings, since not all the
USB report options are supported.

Keyboard Maintainer: [Wayne K. Jones](github.com/WarmCatUK).
Hardware Supported: JJ50 with the ATmega32a chip.
Hardware Availability: [KPrepublic on AliExpress](https://www.aliexpress.com/item/jj50-v1-0-Custom-Mechanical-Keyboard-50-PCB-programmed-50-preonic-layouts-bface-firmware-with-rgb/32848915277.html)

This version by [Wayne K. Jones](github.com/WarmCatUK).


## Installing and Building

Make example for this keyboard (after setting up your build environment):

```
$ make jj50:default:program
$ make kprepublic/jj50:default:program
```
It should detect the keyboard and set it to bootloader mode automatically, prior to flashing firmware.

Expand Down Expand Up @@ -49,7 +49,7 @@ If you prefer, you can just build it and flash the firmware directly with
in the bootloader:

```
$ make jj50
$ make kprepublic/jj50:default
$ bootloadHID -r jj50_default.hex
```
I dont use windows personally, but the following is from ymd96 regarding flashing the atmega32a:
Expand All @@ -60,7 +60,7 @@ On Windows, I use [MINGw](http://www.mingw.org/) to compile the keymaps. On Linu
Once you have those two pieces of software:
Build the keyboard with
```
$ make jj50:default
$ make kprepublic/jj50:default
```
If you make your own layout, change the `default` word to whatever your layout is.

Expand All @@ -75,8 +75,8 @@ And flash the compiled hex file with `HIDBootFlash`. Simply put the board in fla
4. I was occasionally finding that I wasn't flashing changes that I was making to my keymap. If that happens, remove the previous build and simply force rebuild by making with:
```
$ rm jj50_default.hex
$ make -B jj50:default
$ make -B jj50:default:program
$ make -B kprepublic/jj50:default
$ make -B kprepublic/jj50:default:program
```


Expand Down
2 changes: 1 addition & 1 deletion keyboards/kprepublic/staryu/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ Hardware Availability: [AliExpress](https://www.aliexpress.com/item/Staryu-Mini-

Make example for this keyboard (after setting up your build environment):

make staryu:default
make kprepublic/staryu:default

See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
4 changes: 2 additions & 2 deletions keyboards/kprepublic/xd84/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ Hardware Availability: [KPrepublic](https://kprepublic.com/products/xd84-xiudi-7

Make example for this keyboard (after setting up your build environment):

make xd84:default
make kprepublic/xd84:default

Install examples:

make xd84:default:dfu
make kprepublic/xd84:default:dfu

See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
6 changes: 3 additions & 3 deletions keyboards/kprepublic/xd87/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@

Make example for this keyboard (after setting up your build environment):

make xd87:default
make kprepublic/xd87:default

It also supports the tkl_ansi and tkl_iso community layouts:

# Build firmware with ANSI layout
make xd87:default_tkl_ansi
make kprepublic/xd87:default_tkl_ansi
# Build firmware with ISO layout
make xd87:default_tkl_iso
make kprepublic/xd87:default_tkl_iso


The keyboard can be reset to bootloader by using bootmagic (space+b by default) or short out the small connector between the Delete and End keys.
Expand Down