Consolidate all YMDK keyboards into the YMDK directory #12177

ennation · 2021-03-09T08:40:47Z

Description

Consolidate all YMDK keyboards to the YMDK directory, as some were in it and some were not. The YD60MQ, YMD75, YMD96, and YMD_NP21 have been moved into the directory
Update example make commands in the readmes of all YMDK keyboards to use the newer qmk script, and to reflect the movement of the moved keyboards

The exception is the YD68, as although it is named similarly to the YD60, I cannot find anything definitely tying it to YMDK, so I left it out as a precaution.

Currently resolving YMD75 build issues resulting from the move.

Types of Changes

Issues Fixed or Closed by This PR

Checklist

My code follows the code style of this project: C, Python
I have read the PR Checklist document and have made the appropriate changes.
My change requires a change to the documentation.
I have updated the documentation accordingly.
I have read the CONTRIBUTING document.
I have added tests to cover my changes.
I have tested the changes and verified that they work and don't break anything (as well as I can manage).

I thought it odd that there existed a YMDK directory, but only about half the YMDK boards resided there. This simply moves the remaining YMDK keyboards (YD60MQ, YMD75, YMD96, and YMDK_NP21) to the YMDK directory. The exception here is the YD68, which although it shares the YD naming convention with the YD60MQ, I was unable to find anything definitively linking the board to YMDK, so I've left it out as a precaution.

Documentation updates to YD60MQ, YMD75, YMD96, and YMDK_NP21 to reflect the consolidation of YMDK keyboards to the YMDK directory

filterpaper

This is also a good opportunity to update the compilation and flashing commands to qmk script that supports more build options and agnostic to current-directory location.

filterpaper · 2021-03-09T11:39:33Z

keyboards/ymdk/yd60mq/readme.md

+make ymdk/yd60mq:default        # builds the 12 LED variant
+make ymdk/yd60mq/12led:default  # also builds the 12 LED variant
+make ymdk/yd60mq/16led:default  # builds the 16 LED variant


Suggested change

make ymdk/yd60mq:default # builds the 12 LED variant

make ymdk/yd60mq/12led:default # also builds the 12 LED variant

make ymdk/yd60mq/16led:default # builds the 16 LED variant

qmk compile -kb ymdk/yd60mq -km default # builds the 12 LED variant

qmk compile -kb ymdk/yd60mq/12led -km default # also builds the 12 LED variant

qmk compile -kb ymdk/yd60mq/16led -km default # builds the 16 LED variant

filterpaper · 2021-03-09T11:40:39Z

keyboards/ymdk/yd60mq/readme.md

+make ymdk/yd60mq:default:flash        # builds and flashes the 12 LED variant
+make ymdk/yd60mq/12led:default:flash  # also builds and flashes the 12 LED variant
+make ymdk/yd60mq/16led:default:flash  # builds and flashes the 16 LED variant


Suggested change

make ymdk/yd60mq:default:flash # builds and flashes the 12 LED variant

make ymdk/yd60mq/12led:default:flash # also builds and flashes the 12 LED variant

make ymdk/yd60mq/16led:default:flash # builds and flashes the 16 LED variant

qmk flash -kb ymdk/yd60mq -km default # builds and flashes the 12 LED variant

qmk flash -kb ymdk/yd60mq/12led -km default # also builds and flashes the 12 LED variant

qmk flash -kb ymdk/yd60mq/16led -km default # builds and flashes the 16 LED variant

filterpaper · 2021-03-09T11:41:06Z

keyboards/ymdk/ymd75/readme.md

@@ -13,11 +13,11 @@ This firmware can also be flashed onto the KBDFans KBD75 Round 2 Bootmapper Clie

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

-    make ymd75/rev1:default
+    make ymdk/ymd75/rev1:default


Suggested change

make ymdk/ymd75/rev1:default

qmk compile -kb ymdk/ymd75/rev1 -km default

filterpaper · 2021-03-09T11:41:28Z

keyboards/ymdk/ymd75/readme.md


 Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-    make ymd75/rev1:default:flash
+    make ymdk/ymd75/rev1:default:flash


Suggested change

make ymdk/ymd75/rev1:default:flash

qmk flash -kb ymdk/ymd75/rev1 -km default

filterpaper · 2021-03-09T11:42:01Z

keyboards/ymdk/ymd96/readme.md

@@ -8,11 +8,11 @@ A 96-keyboard which supports both ANSI and ISO along with many different layout

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

-    make ymd96:default
+    make ymdk/ymd96:default


Suggested change

make ymdk/ymd96:default

qmk compile -kb ymdk/ymd96 -km default

filterpaper · 2021-03-09T11:42:19Z

keyboards/ymdk/ymd96/readme.md


 Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-    make ymd96:default:flash
+    make ymdk/ymd96:default:flash


Suggested change

make ymdk/ymd96:default:flash

qmk flash -kb ymdk/ymd96 -km default

filterpaper · 2021-03-09T11:43:47Z

keyboards/ymdk/ymdk_np21/readme.md

@@ -10,11 +10,11 @@ ps2avrGB based number-pad sold fully assembled by YMDK on Aliexpress.

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

-    make ymdk_np21:default
+    make ymdk/ymdk_np21:default


Suggested change

make ymdk/ymdk_np21:default

qmk compile -kb ymdk/ymdk_np21 -km default

filterpaper · 2021-03-09T11:44:03Z

keyboards/ymdk/ymdk_np21/readme.md


 Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))

-    make ymdk_np21:default:flash
+    make ymdk/ymdk_np21:default:flash


Suggested change

make ymdk/ymdk_np21:default:flash

qmk flash -kb ymdk/ymdk_np21 -km default

This reverts commit a707767.

This reverts commit c50a5d5.

ennation · 2021-03-09T22:20:32Z

This is also a good opportunity to update the compilation and flashing commands to qmk script that supports more build options and agnostic to current-directory location.

Agreed. Still working out some issues with the YMD75 compile though. @drashna said in the QMK Discord that I might need to update some include statements for that board, but after looking at other boards with a similar file hierarchy, I'm not sure what I need to do to them.

fauxpark · 2021-03-09T22:35:04Z

You'll need to add ymdk_ to the ifdefs in ymd75.h:

#if defined(KEYBOARD_ymdk_ymd75_rev1)
    #include "rev1.h"
#elif defined(KEYBOARD_ymdk_ymd75_rev2)
    #include "rev2.h"
#elif defined(KEYBOARD_ymdk_ymd75_rev3)
    #include "rev3.h"
#endif

This reverts commit 3b79a0e.

This reverts commit e507239.

Consolidate all YMDK keyboards into the YMDK directory

stale · 2021-06-02T16:29:34Z

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

stale · 2021-07-08T00:47:23Z

Thank you for your contribution!
This pull request has been automatically closed because it has not had activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready.

ennation added 2 commits March 9, 2021 01:25

Update documentation of remaining YMDK boards

a707767

Documentation updates to YD60MQ, YMD75, YMD96, and YMDK_NP21 to reflect the consolidation of YMDK keyboards to the YMDK directory

github-actions bot added keyboard keymap via Adds via keymap and/or updates keyboard for via support labels Mar 9, 2021

filterpaper suggested changes Mar 9, 2021

View reviewed changes

ennation added 2 commits March 9, 2021 16:27

Revert "Update documentation of remaining YMDK boards"

e507239

This reverts commit a707767.

Revert "Move all YMDK boards to the same directory"

3b79a0e

This reverts commit c50a5d5.

github-actions bot removed keymap keyboard via Adds via keymap and/or updates keyboard for via support labels Mar 9, 2021

ennation added 6 commits March 9, 2021 17:50

Update DEFAULT_FOLDERs in rules.mk for YMD75 and YD60MQ

3b32721

Update include statements for the YMD75

26e0ab5

Update all YMDK documentation to use new qmk script

121c3cc

Revert "Revert "Move all YMDK boards to the same directory""

c8d1819

This reverts commit 3b79a0e.

Revert "Revert "Update documentation of remaining YMDK boards""

91bd63a

This reverts commit e507239.

Merge pull request #1 from ennation/ymdk-consolidation

299104d

Consolidate all YMDK keyboards into the YMDK directory

github-actions bot added keyboard keymap via Adds via keymap and/or updates keyboard for via support labels Mar 9, 2021

ennation marked this pull request as ready for review March 9, 2021 23:06

stale bot added the awaiting changes label Jun 2, 2021

stale bot closed this Jul 8, 2021

This was referenced Dec 29, 2021

Tracking issue for YMDK organization #15639

Closed

Scoping and tracking for board relocations within QMK #15696

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Consolidate all YMDK keyboards into the YMDK directory #12177

Consolidate all YMDK keyboards into the YMDK directory #12177

ennation commented Mar 9, 2021 •

edited

Loading

filterpaper left a comment

filterpaper Mar 9, 2021

filterpaper Mar 9, 2021

filterpaper Mar 9, 2021

filterpaper Mar 9, 2021

filterpaper Mar 9, 2021

filterpaper Mar 9, 2021

filterpaper Mar 9, 2021

filterpaper Mar 9, 2021

ennation commented Mar 9, 2021

fauxpark commented Mar 9, 2021

stale bot commented Jun 2, 2021

stale bot commented Jul 8, 2021

	make ymdk/ymd75/rev1:default
	qmk compile -kb ymdk/ymd75/rev1 -km default

	make ymdk/ymd75/rev1:default:flash
	qmk flash -kb ymdk/ymd75/rev1 -km default

	make ymdk/ymd96:default
	qmk compile -kb ymdk/ymd96 -km default

	make ymdk/ymd96:default:flash
	qmk flash -kb ymdk/ymd96 -km default

	make ymdk/ymdk_np21:default
	qmk compile -kb ymdk/ymdk_np21 -km default

	make ymdk/ymdk_np21:default:flash
	qmk flash -kb ymdk/ymdk_np21 -km default

Consolidate all YMDK keyboards into the YMDK directory #12177

Consolidate all YMDK keyboards into the YMDK directory #12177

Conversation

ennation commented Mar 9, 2021 • edited Loading

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

filterpaper left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ennation commented Mar 9, 2021

fauxpark commented Mar 9, 2021

stale bot commented Jun 2, 2021

stale bot commented Jul 8, 2021

ennation commented Mar 9, 2021 •

edited

Loading