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

Updated templates for use by new_project.sh #3783

Merged
merged 6 commits into from
Aug 29, 2018

Conversation

noroadsleft
Copy link
Member

template.h file cleanup

Reformatted the pre-macro comments as block comments.

Updated the ps2avrgb template comment to match the avr template's comment, which was more informative.

Deleted the line about the macro representing the Planck MIT layout, because the macro doesn't represent that layout anymore.

base template keymap.c refactor

Deleted the deprecated TMK macro functions.

Defined two custom keycodes for use as macros by process_record_user.

process_record_user is now after the keymap and before matrix_init_user, where the deleted TMK functions were.

Keymap function has a white space change to make it follow QMK white space guidelines.

Reformatted the pre-macro comments as block comments.

Updated the ps2avrgb template comment to match the avr template's comment, which was more informative.

Deleted the line about the macro representing the Planck MIT layout, because the macro doesn't represent that layout anymore.
Deleted the deprecated TMK macro functions.

Defined two custom keycodes for use as macros by process_record_user.

process_record_user is now after the keymap and before matrix_init_user, where the deleted TMK functions were.
@noroadsleft
Copy link
Member Author

Fixes #3782

case QMKURL:
if (record->event.pressed) {
// when keycode QMKURL is pressed
SEND_STRING("https://qmk.fm/" SS_TAP(X_ENTER)");
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have an extra " at the end

@drashna
Copy link
Member

drashna commented Aug 28, 2018

Also, want to add a section for BOOTLOADER rather that the BOOTLOADER_SIZE stuff (though, keep that still, but as a "fall back")?

@noroadsleft
Copy link
Member Author

What bootloader(s), if any, should I set as default? Is it same for AVR and ps2avrGB? or different for each?

@drashna
Copy link
Member

drashna commented Aug 28, 2018

https://docs.qmk.fm/#/config_options?id=avr-mcu-options

I think the ps2avrgb all use bootloadHID, but the AVR use different ones.

@noroadsleft
Copy link
Member Author

Done. ps2avrgb rules.mk had the BOOTLOADER rule defined already.

@drashna
Copy link
Member

drashna commented Aug 28, 2018

To clarify here, this line is only needed if we don't know the bootloader:

OPT_DEFS += -DBOOTLOADER_SIZE=4096

Specifying the bootloader size should only be done if you don't know which bootloader.

Eg, this section:

should be more like:

# Bootloader selection
#   Teensy       halfkay
#   Pro Micro     caterina
#   Atmel DFU    atmel-dfu
#   LUFA DFU     lufa-dfu
#   QMK DFU     qmk-dfu
#   atmega32a    bootloadHID
BOOTLOADER = lufa-dfu

# If you don't know the bootloader type, then you can specify the 
# Boot Section Size in *bytes* by uncommenting out the OPT_DEFS lone
#   Teensy halfKay   512
#   Teensy++ halfKay 1024
#   Atmel DFU loader 4096
#   LUFA bootloader  4096
#   USBaspLoader     2048
#OPT_DEFS += -DBOOTLOADER_SIZE=4096

@drashna
Copy link
Member

drashna commented Aug 29, 2018

Also, don't kill me.... but could you update the links in the readme's? The bottom ones?

… readme.md files

Corrected the links to the Build Environment Setup and the Make Instructions docs.

Added direct link to the QMK Complete Newbs Guide.
@noroadsleft
Copy link
Member Author

I can't believe I didn't think of doing that while I was in here. The broken links have been bugging me for weeks.

Also dropped a link to the Complete Newbs Guide in, because I think it fits here. I actually had a branch with that change already done but I never filed an issue or PR. 😞

@drashna
Copy link
Member

drashna commented Aug 29, 2018

Perfect!

@drashna drashna merged commit 836efb5 into qmk:master Aug 29, 2018
@noroadsleft noroadsleft deleted the new_project_templates branch August 29, 2018 18:01
Shinichi-Ohki added a commit to Shinichi-Ohki/qmk_firmware that referenced this pull request Aug 31, 2018
* 'master' of https://github.com/qmk/qmk_firmware: (73 commits)
  Keymap: Updated keymap with the "pretty" layout (qmk#3812)
  Keyboard: CTRL and ALT updates (qmk#3810)
  Docs: Tabulate Modifier & Mod-Tap keycode listings in advanced keycodes docs (qmk#3799)
  Keymap: Wanleg updates (qmk#3794)
  Keymap: Added new tada68 keymap (qmk#3788)
  Tweak the wording in "Becoming a QMK Collaborator"
  Docs: add process_terminal() and update links to other functions (qmk#3778)
  Keymap: Update keymap including LAYOUT_planck_grid (qmk#3779)
  Keyboard: remove old comment from keyboards/helix/rules.mk (qmk#3795)
  Keyboard: Update CTRL and ALT keyboard readme (qmk#3796)
  Mask off keycode/layer/mod where possible in LT(), MT(), etc. (qmk#3430)
  Autodetect lack of screen presence
  Massdrop keyboards readme update (qmk#3791)
  move massdrop boards into its own directory for configurator visibility
  STM32 EEPROM Emulation (qmk#3741)
  Massdrop keyboard support (qmk#3780)
  Keymap: Add german layout for redox keyboard (qmk#3695)
  Keyboard: Adding the AT101 PCB (qmk#3785)
  Updated templates for use by new_project.sh (qmk#3783)
  Fixed bootloader target Fixed matching grep matches (for PRODUCT in particular) Fixed " Bootloader" concatenation for WSL (windows line-endings)
  ...
alexey-danilov pushed a commit to alexey-danilov/qmk_firmware that referenced this pull request Sep 6, 2018
* template.h file cleanup

Reformatted the pre-macro comments as block comments.

Updated the ps2avrgb template comment to match the avr template's comment, which was more informative.

Deleted the line about the macro representing the Planck MIT layout, because the macro doesn't represent that layout anymore.

* base template keymap.c refactor

Deleted the deprecated TMK macro functions.

Defined two custom keycodes for use as macros by process_record_user.

process_record_user is now after the keymap and before matrix_init_user, where the deleted TMK functions were.

* Removed an extra " from macro command per @drashna

* Added BOOTLOADER rule to avr/rules.mk per @drashna

* Updated Bootloader sections per @drashna

* Updated links to docs at the bottom of both avr and ps2avrgb template readme.md files

Corrected the links to the Build Environment Setup and the Make Instructions docs.

Added direct link to the QMK Complete Newbs Guide.
ChrissiQ pushed a commit to ChrissiQ/qmk_firmware that referenced this pull request Sep 25, 2018
* template.h file cleanup

Reformatted the pre-macro comments as block comments.

Updated the ps2avrgb template comment to match the avr template's comment, which was more informative.

Deleted the line about the macro representing the Planck MIT layout, because the macro doesn't represent that layout anymore.

* base template keymap.c refactor

Deleted the deprecated TMK macro functions.

Defined two custom keycodes for use as macros by process_record_user.

process_record_user is now after the keymap and before matrix_init_user, where the deleted TMK functions were.

* Removed an extra " from macro command per @drashna

* Added BOOTLOADER rule to avr/rules.mk per @drashna

* Updated Bootloader sections per @drashna

* Updated links to docs at the bottom of both avr and ps2avrgb template readme.md files

Corrected the links to the Build Environment Setup and the Make Instructions docs.

Added direct link to the QMK Complete Newbs Guide.
yamad pushed a commit to yamad/qmk_firmware that referenced this pull request Apr 10, 2019
* template.h file cleanup

Reformatted the pre-macro comments as block comments.

Updated the ps2avrgb template comment to match the avr template's comment, which was more informative.

Deleted the line about the macro representing the Planck MIT layout, because the macro doesn't represent that layout anymore.

* base template keymap.c refactor

Deleted the deprecated TMK macro functions.

Defined two custom keycodes for use as macros by process_record_user.

process_record_user is now after the keymap and before matrix_init_user, where the deleted TMK functions were.

* Removed an extra " from macro command per @drashna

* Added BOOTLOADER rule to avr/rules.mk per @drashna

* Updated Bootloader sections per @drashna

* Updated links to docs at the bottom of both avr and ps2avrgb template readme.md files

Corrected the links to the Build Environment Setup and the Make Instructions docs.

Added direct link to the QMK Complete Newbs Guide.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants