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

Update readme files for moved keyboards #14784

Closed
wants to merge 3 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions keyboards/kprepublic/bm40hsrgb/keymaps/gabustoledo/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

- Compile:

`qmk compile -kb bm40hsrgb -km gabustoledo`
`qmk compile -kb kprepublic/bm40hsrgb -km gabustoledo`

### Flash

- Flash:

`qmk flash -kb bm40hsrgb -km gabustoledo`
`qmk flash -kb kprepublic/bm40hsrgb -km gabustoledo`

# Layout

Expand Down
4 changes: 2 additions & 2 deletions keyboards/kprepublic/bm40hsrgb/keymaps/signynt/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ Sigma Squared modifies on **Miryoku** in the following ways:

- to directly flash to board:

`qmk flash -kb bm40hsrgb -km signynt`
`qmk flash -kb kprepublic/bm40hsrgb -km signynt`

- to only compile:

`qmk compile -kb bm40hsrgb -km signynt`
`qmk compile -kb kprepublic/bm40hsrgb -km signynt`



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ Sigma Squared modifies on **Miryoku** in the following ways:

- to directly flash to board:

`qmk flash -kb bm40hsrgb -km signynt`
`qmk flash -kb kprepublic/bm40hsrgb -km signynt`

- to only compile:

`qmk compile -kb bm40hsrgb -km signynt`
`qmk compile -kb kprepublic/bm40hsrgb -km signynt`



Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ Sigma Squared modifies on **Miryoku** in the following ways:

- to directly flash to board:

`qmk flash -kb bm40hsrgb -km signynt`
`qmk flash -kb kprepublic/bm40hsrgb -km signynt`

- to only compile:

`qmk compile -kb bm40hsrgb -km signynt`
`qmk compile -kb kprepublic/bm40hsrgb -km signynt`



Expand Down
4 changes: 2 additions & 2 deletions keyboards/kprepublic/bm43a/keymaps/stevexyz/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ And a view on the actual build:

![layout](https://raw.githubusercontent.com/stevexyz/qmk_firmware/master/keyboards/bm43a/keymaps/stevexyz/actualbuild.jpeg)

In order to compile the module from qmk root directory use the command 'make bm43a:stevexyz'
In order to compile the module from qmk root directory use the command 'make kprepublic/bm43a:stevexyz'

And in order to upload the new firmware use the command: 'qmk flash -kb bm43a -km stevexyz' (you can initiate programming with keyboard RESET key, that in this keymap has been moved on the backspace button in the "lights" layer)
And in order to upload the new firmware use the command: 'qmk flash -kb kprepublic/bm43a -km stevexyz' (you can initiate programming with keyboard RESET key, that in this keymap has been moved on the backspace button in the "lights" layer)

4 changes: 2 additions & 2 deletions keyboards/kprepublic/bm65iso/keymaps/deadolus/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@

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

make bm65iso:deadolus
make kprepublic/bm65iso:deadolus

Flashing example for this keyboard:

make bm65iso:deadolus:flash
make kprepublic/bm65iso:deadolus:flash

Keyboard Maintainer: **[deadolus](https://github.com/deadolus)**
4 changes: 2 additions & 2 deletions keyboards/kprepublic/jj40/keymaps/cockpit/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,8 @@

```bash
cd qmk_firmware
make jj40:cockpit
bootloadHID .build/jj40_cockpit.hex
make kprepublic/jj40:cockpit
bootloadHID .build/kprepublic_jj40_cockpit.hex
```

_if you're getting permission errors use sudo_
2 changes: 1 addition & 1 deletion keyboards/kprepublic/jj40/keymaps/waples/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ I currently have the following layers in my keymap:
* Dual (adjust)

### Note to self:
YOU NEED TO USE [bootloadHID -r jj40_waples.hex](https://github.com/qmk/qmk_firmware/tree/master/keyboards/jj40)
YOU NEED TO USE [bootloadHID -r kprepublic_jj40_waples.hex](https://github.com/qmk/qmk_firmware/tree/master/keyboards/jj40)

## the stuff below is out of date and I think about removing them from this readme

Expand Down
2 changes: 1 addition & 1 deletion keyboards/ktec/ergodone/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ The ErgoDone uses a customized HID bootloader rather than the Teensy one. It doe
![Ergodone Flash Mode](https://i.imgur.com/sNivAnr.jpg)
2. To flash the .hex file, use the `hid_bootloader_cli` utlity from the [TKG Toolkit](https://github.com/kairyu/tkg-toolkit) (as of 2017-10-03, only [this old version](https://github.com/kairyu/tkg-toolkit/blob/b14c67ca8bc84c07e5fc6b2e01ae4002b808243a/windows/bin/hid_bootloader_cli.exe) works under Windows):

hid_bootloader_cli -mmcu=atmega32u4 ergodone_default.hex
hid_bootloader_cli -mmcu=atmega32u4 ktec_ergodone_default.hex
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd002/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ sudo udevadm trigger
**Reset Key**: Hold down key nearest to the USB socket while plugging in the keyboard.

```bash
make xd002:default:flash
make xiudi/xd002:default:flash

# or directly with...
micronucleus --run <firmware.hex>
Expand Down
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd004/keymaps/system_and_media/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ It also has a 'Super Alt-F4' key for Windows that, when tapped does Alt-F4, unle

## Build

To build the keymap, simply run `make xd004:system_and_media`.
To build the keymap, simply run `make xiudi/xd004:system_and_media`.
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd60/keymaps/Jos/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@ There are a few `#define` lines at the beginning of the keymap file that enable


# Build
To build, simply run `make xd60:Jos`
To build, simply run `make xiudi/xd60:Jos`
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd60/keymaps/birkir/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@ RGB settings are persisted for layer 0 when done.
- More dynamic keyboard configuration on Layer 2

## Build
To build the default keymap, simply run `make xd60:birkir`.
To build the default keymap, simply run `make xiudi/xd60:birkir`.
4 changes: 2 additions & 2 deletions keyboards/xiudi/xd60/keymaps/default/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Default Keymap for XD60 as indicated on the original sale page.

To build the default keymap, simply run:

make xd60/rev2:default # XD60 rev2
make xd60/rev3:default # XD60 rev3
make xiudi/xd60/rev2:default # XD60 rev2
make xiudi/xd60/rev3:default # XD60 rev3
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd60/keymaps/edulpn/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
![Edulpn Keymap for the XD60 PCB](https://i.imgur.com/PoL5qcr.png)

## Build
To build the default keymap, simply run `make xd60:edulpn`.
To build the default keymap, simply run `make xiudi/xd60:edulpn`.
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd60/keymaps/edulpn64/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
This keymap uses the Default XD60 base layer, but follows the GK64 function layer (one of my XD60 boards use GK64 keycaps).

## Build
To build the default keymap, simply run `make xd60:edulpn64`.
To build the default keymap, simply run `make xiudi/xd60:edulpn64`.
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd60/keymaps/fvolpe83/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ via has been enabled

To build the keymap, simply run:

make xd60/rev3:fvolpe83 # XD60 rev3
make xiudi/xd60/rev3:fvolpe83 # XD60 rev3


![Keyboard Layout (Physical appearence)](https://i.imgur.com/CSRPjbX.png "physical layout")
4 changes: 2 additions & 2 deletions keyboards/xiudi/xd60/keymaps/iso/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ iso Keymap for XD60.

To build the default keymap, simply run:

make xd60/rev2:iso # XD60 rev2
make xd60/rev3:iso # XD60 rev3
make xiudi/xd60/rev2:iso # XD60 rev2
make xiudi/xd60/rev3:iso # XD60 rev3
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd60/keymaps/kmontag42/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ This layout is WIP for me as I use my shiny new keyboard more and more. I will
* I use emacs, which could account for some of the oddities in my layout and macros

## Build
To build the default keymap, simply run `make xd60:kmontag42`.
To build the default keymap, simply run `make xiudi/xd60:kmontag42`.
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd60/keymaps/krusli/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
Keymap for the XD60 (ANSI) with 2.25u left shift, split right shift. HHKB-like function layer.

## Build
To build this keymap, simply run `make xd60:krusli` on the top-level directory for QMK.
To build this keymap, simply run `make xiudi/xd60:krusli` on the top-level directory for QMK.
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd60/keymaps/melka/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ To define your password, rename passwd_template.h file to passwd.h and edit the

To build this keymap, simply run:

make xd60/rev3:melka # XD60 rev3
make xiudi/xd60/rev3:melka # XD60 rev3
4 changes: 2 additions & 2 deletions keyboards/xiudi/xd60/keymaps/petesmom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Customized xd60 keymap based on yuuki's but a step sideways with Mac support. Fo

## Programming Instructions

Change the layout in `keymap.c` then run `make xd60-petesmom`. The compiled file will be located in `.build/xd60_petesmom.hex` relative to the project root. To flash it onto your keyboard, use whatever program works on your OS. I personally use `dfu-programmer`, and run:
Change the layout in `keymap.c` then run `make xiudi/xd60:petesmom`. The compiled file will be located in `.build/xiudi_xd60_petesmom.hex` relative to the project root. To flash it onto your keyboard, use whatever program works on your OS. I personally use `dfu-programmer`, and run:

* `sudo dfu-programmer atmega32u4 erase`
* `sudo dfu-programmer atmega32u4 flash .build/xd60-petesmom.hex`
* `sudo dfu-programmer atmega32u4 flash .build/xiudi_xd60-petesmom.hex`
* `sudo dfu-programmer atmega32u4 start`

## Layout
Expand Down
4 changes: 2 additions & 2 deletions keyboards/xiudi/xd60/keymaps/semicolonsnet/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Custom Keymap for XD60 - uses a META key and lots of shortcut keys that are late

To build the default keymap, simply run:

make xd60/rev2:default # XD60 rev2
make xd60/rev3:default # XD60 rev3
make xiudi/xd60/rev2:default # XD60 rev2
make xiudi/xd60/rev3:default # XD60 rev3
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd60/keymaps/styr/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
Default Keymap for XD60 as indicated on the original sale page.

## Build
To build the default keymap, simply run `make xd60/rev3:styr`.
To build the default keymap, simply run `make xiudi/xd60/rev3:styr`.
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd60/keymaps/supercoffee/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
60% Keymap for XD60 with GH60 ANSI layout. Arrow keys mapped to WASD in function layer.

## Build
To build the default keymap, simply run `make xd60:supercoffee`.
To build the default keymap, simply run `make xiudi/xd60:supercoffee`.
4 changes: 2 additions & 2 deletions keyboards/xiudi/xd60/keymaps/yuuki/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ Customized xd60 keymap with inspirations from HHKB and the layout I used on my V

## Programming Instructions

Change the layout in `keymap.c` then run `make xd60:yuuki`. The compiled file will be located in `.build/xd60_yuuki.hex` relative to the project root. To flash it onto your keyboard, use whatever program works on your OS. I personally use `dfu-programmer`, and run:
Change the layout in `keymap.c` then run `make xiudi/xd60:yuuki`. The compiled file will be located in `.build/xiudi_xd60_yuuki.hex` relative to the project root. To flash it onto your keyboard, use whatever program works on your OS. I personally use `dfu-programmer`, and run:

* reset keyboard by pressing the reset button on the back of the PCB
* `sudo dfu-programmer atmega32u4 erase`
* `sudo dfu-programmer atmega32u4 flash .build/xd60_yuuki.hex`
* `sudo dfu-programmer atmega32u4 flash .build/xiudi_xd60_yuuki.hex`
* `sudo dfu-programmer atmega32u4 start`

## Layout
Expand Down
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd68/keymaps/default/readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# XD68 layout for Default ANSI

```
make xd68:default
make xiudi/xd68:default
```
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd68/keymaps/default_iso/readme.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# XD68 layout for Default ISO

```
make xd68:default_iso
make xiudi/xd68:default_iso
```
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd75/keymaps/bbaserdem/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@

Take the board into reset mode, then
```
make xd75:bbaserdem:dfu
make xiudi/xd75:bbaserdem:dfu
```
Either sudo it or set permissions in udev.
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd75/keymaps/buzzlighter1/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,5 +50,5 @@ $ cd qmk_firmware

build
```
$ make xd75:buzzlighter1
$ make xiudi/xd75:buzzlighter1
```
4 changes: 2 additions & 2 deletions keyboards/xiudi/xd75/keymaps/clanghans/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

* Build/Flash
qmk setup
qmk compile -kb xd75 -km clanghans
qmk flash -kb xd75 -km clanghans
qmk compile -kb xiudi/xd75 -km clanghans
qmk flash -kb xiudi/xd75 -km clanghans

Hit 'Raise'+'PgUp' for entering bootloader mode
8 changes: 4 additions & 4 deletions keyboards/xiudi/xd75/keymaps/colinta/readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# colinta's keymap for XD75

```
make xd75:colinta:dfu
make xiudi/xd75:colinta:dfu
```

The default layout is a Colemak keyboard with "one-shot" keys assigned to the modifier keys.
Expand Down Expand Up @@ -41,13 +41,13 @@ If you would *also* like to take advantage of this feature, you'll first want to
# exclude patterns (uncomment them if you want to use them):
# *.[oa]
# *~
/keyboards/xd75/keymaps/colinta/secrets.h
/keyboards/xiudi/xd75/keymaps/colinta/secrets.h
```

Then you can create this file and add your macro strings to it:

```
$EDITOR keyboards/xd75/keymaps/colinta/secrets.h
$EDITOR keyboards/xiudi/xd75/keymaps/colinta/secrets.h
```

###### secrets.h
Expand All @@ -60,5 +60,5 @@ $EDITOR keyboards/xd75/keymaps/colinta/secrets.h
To include the feature at compile time, include the flag `IS_COLINTA` like so:

```
make xd75:colinta:dfu EXTRAFLAGS=-DIS_COLINTA
make xiudi/xd75:colinta:dfu EXTRAFLAGS=-DIS_COLINTA
```
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd75/keymaps/developper_bepo/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ Keyboard maintainer: [Quentin Lebastard](https://github.com/lebastaq)

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

make xd75:developper_bepo
make xiudi/xd75:developper_bepo
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd75/keymaps/french/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ La touche de fonction permet elle d'avoir accès aux différentes touches multim
# Compilation

```
make xd75:french:dfu
make xiudi/xd75:french:dfu
```
4 changes: 2 additions & 2 deletions keyboards/xiudi/xd75/keymaps/scheiklp/readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# KOY Layout for the xd75 pcb board
Compile the layout
```bash
qmk compile -kb xd75 -km scheiklp
qmk compile -kb xiudi/xd75 -km scheiklp
```
and flash it to the board
```bash
qmk flash -kb xd75 -km scheiklp
qmk flash -kb xiudi/xd75 -km scheiklp
```
2 changes: 1 addition & 1 deletion keyboards/xiudi/xd75/keymaps/tdl-jturner/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

Keyboard Layout Editor: [Link](http://www.keyboard-layout-editor.com/#/gists/b2b23097ef70fd9170e266e4cbc06c02)

Make Command: make xd75:tdl-jturner
Make Command: make xiudi/xd75:tdl-jturner

Notes:
* Based on Qwerty
Expand Down