~ruther/qmk_firmware

0d936b2fe6a2518f2562c59f7f84692590d77aa0 — fauxpark 6 years ago 7ba2bc7
Ask for your name when generating a new keyboard (#5214)

* Ask for your name when generating a new keyboard

* Update docs

* Apply suggestions from code review

Co-Authored-By: fauxpark <fauxpark@gmail.com>
M docs/contributing.md => docs/contributing.md +2 -2
@@ 137,7 137,7 @@ Most first-time QMK contributors start with their personal keymaps. We try to ke
* All Keymap PR's are squashed, so if you care about how your commits are squashed you should do it yourself
* Do not lump features in with keymap PR's. Submit the feature first and then a second PR for the keymap.
* Do not include `Makefile`s in your keymap folder (they're no longer used)
* Update copyrights in file headers (look for `REPLACE_WITH_YOUR_NAME `)
* Update copyrights in file headers (look for `%YOUR_NAME%`)

## Keyboards



@@ 150,7 150,7 @@ We also ask that you follow these guidelines:
* Do not lump core features in with new keyboards. Submit the feature first and then submit a separate PR for the keyboard.
* Name `.c`/`.h` file after the immediate parent folder, eg `/keyboards/<kb1>/<kb2>/<kb2>.[ch]`
* Do not include `Makefile`s in your keyboard folder (they're no longer used)
* Update copyrights in file headers (look for `REPLACE_WITH_YOUR_NAME `)
* Update copyrights in file headers (look for `%YOUR_NAME%`)

## Quantum/TMK Core


M quantum/template/avr/config.h => quantum/template/avr/config.h +2 -2
@@ 1,5 1,5 @@
/*
Copyright 2019 REPLACE_WITH_YOUR_NAME
Copyright 2019 %YOUR_NAME%

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by


@@ 23,7 23,7 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
#define VENDOR_ID       0xFEED
#define PRODUCT_ID      0x0000
#define DEVICE_VER      0x0001
#define MANUFACTURER    You
#define MANUFACTURER    %YOUR_NAME%
#define PRODUCT         %KEYBOARD%
#define DESCRIPTION     A custom keyboard


M quantum/template/avr/readme.md => quantum/template/avr/readme.md +1 -1
@@ 4,7 4,7 @@

A short description of the keyboard/project

Keyboard Maintainer: [You](https://github.com/yourusername)  
Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)  
Hardware Supported: The PCBs, controllers supported  
Hardware Availability: links to where you can find this hardware


M quantum/template/avr/template.c => quantum/template/avr/template.c +1 -1
@@ 1,4 1,4 @@
/* Copyright 2019 REPLACE_WITH_YOUR_NAME
/* Copyright 2019 %YOUR_NAME%
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by

M quantum/template/base/keymaps/default/config.h => quantum/template/base/keymaps/default/config.h +1 -1
@@ 1,4 1,4 @@
/* Copyright 2019 REPLACE_WITH_YOUR_NAME
/* Copyright 2019 %YOUR_NAME%
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by

M quantum/template/base/keymaps/default/keymap.c => quantum/template/base/keymaps/default/keymap.c +1 -1
@@ 1,4 1,4 @@
/* Copyright 2019 REPLACE_WITH_YOUR_NAME
/* Copyright 2019 %YOUR_NAME%
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by

M quantum/template/base/template.h => quantum/template/base/template.h +1 -1
@@ 1,4 1,4 @@
/* Copyright 2019 REPLACE_WITH_YOUR_NAME
/* Copyright 2019 %YOUR_NAME%
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by

M quantum/template/ps2avrgb/template.c => quantum/template/ps2avrgb/template.c +1 -1
@@ 1,4 1,4 @@
/* Copyright 2019 REPLACE_WITH_YOUR_NAME
/* Copyright 2019 %YOUR_NAME%
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by

M util/new_project.sh => util/new_project.sh +6 -2
@@ 43,7 43,11 @@ GIT=$(whereis git)
if [ "$GIT" != "" ]; then
  IS_GIT_REPO=$($GIT log >>/dev/null 2>&1; echo $?)
  if [ "$IS_GIT_REPO" -eq 0 ]; then
    ID="'$($GIT config --get user.name)'"
    ID="$($GIT config --get user.name)"
    read -rp "What is your name? [$ID] " YOUR_NAME
    if [ -n "$YOUR_NAME" ]; then
      ID=$YOUR_NAME
    fi
    echo "Using $ID as user name"

    for i in "$NEW_KBD/config.h" \


@@ 52,7 56,7 @@ if [ "$GIT" != "" ]; then
             "$NEW_KBD/keymaps/default/config.h" \
             "$NEW_KBD/keymaps/default/keymap.c"
    do
      awk -v id="$ID" '{sub(/REPLACE_WITH_YOUR_NAME/,id); print}' < "$i" > "$i.$$"
      awk -v id="$ID" '{sub(/%YOUR_NAME%/,id); print}' < "$i" > "$i.$$"
      mv "$i.$$" "$i"
    done
  fi