aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/contributing.md4
-rw-r--r--quantum/template/avr/config.h4
-rw-r--r--quantum/template/avr/readme.md2
-rw-r--r--quantum/template/avr/template.c2
-rw-r--r--quantum/template/base/keymaps/default/config.h2
-rw-r--r--quantum/template/base/keymaps/default/keymap.c2
-rw-r--r--quantum/template/base/template.h2
-rw-r--r--quantum/template/ps2avrgb/template.c2
-rwxr-xr-xutil/new_project.sh8
9 files changed, 16 insertions, 12 deletions
diff --git a/docs/contributing.md b/docs/contributing.md
index eee40609b..88b9d7d9b 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -137,7 +137,7 @@ Most first-time QMK contributors start with their personal keymaps. We try to ke
137* All Keymap PR's are squashed, so if you care about how your commits are squashed you should do it yourself 137* All Keymap PR's are squashed, so if you care about how your commits are squashed you should do it yourself
138* Do not lump features in with keymap PR's. Submit the feature first and then a second PR for the keymap. 138* Do not lump features in with keymap PR's. Submit the feature first and then a second PR for the keymap.
139* Do not include `Makefile`s in your keymap folder (they're no longer used) 139* Do not include `Makefile`s in your keymap folder (they're no longer used)
140* Update copyrights in file headers (look for `REPLACE_WITH_YOUR_NAME `) 140* Update copyrights in file headers (look for `%YOUR_NAME%`)
141 141
142## Keyboards 142## Keyboards
143 143
@@ -150,7 +150,7 @@ We also ask that you follow these guidelines:
150* Do not lump core features in with new keyboards. Submit the feature first and then submit a separate PR for the keyboard. 150* Do not lump core features in with new keyboards. Submit the feature first and then submit a separate PR for the keyboard.
151* Name `.c`/`.h` file after the immediate parent folder, eg `/keyboards/<kb1>/<kb2>/<kb2>.[ch]` 151* Name `.c`/`.h` file after the immediate parent folder, eg `/keyboards/<kb1>/<kb2>/<kb2>.[ch]`
152* Do not include `Makefile`s in your keyboard folder (they're no longer used) 152* Do not include `Makefile`s in your keyboard folder (they're no longer used)
153* Update copyrights in file headers (look for `REPLACE_WITH_YOUR_NAME `) 153* Update copyrights in file headers (look for `%YOUR_NAME%`)
154 154
155## Quantum/TMK Core 155## Quantum/TMK Core
156 156
diff --git a/quantum/template/avr/config.h b/quantum/template/avr/config.h
index 2409ae186..a9bb75482 100644
--- a/quantum/template/avr/config.h
+++ b/quantum/template/avr/config.h
@@ -1,5 +1,5 @@
1/* 1/*
2Copyright 2019 REPLACE_WITH_YOUR_NAME 2Copyright 2019 %YOUR_NAME%
3 3
4This program is free software: you can redistribute it and/or modify 4This program is free software: you can redistribute it and/or modify
5it under the terms of the GNU General Public License as published by 5it 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/>.
23#define VENDOR_ID 0xFEED 23#define VENDOR_ID 0xFEED
24#define PRODUCT_ID 0x0000 24#define PRODUCT_ID 0x0000
25#define DEVICE_VER 0x0001 25#define DEVICE_VER 0x0001
26#define MANUFACTURER You 26#define MANUFACTURER %YOUR_NAME%
27#define PRODUCT %KEYBOARD% 27#define PRODUCT %KEYBOARD%
28#define DESCRIPTION A custom keyboard 28#define DESCRIPTION A custom keyboard
29 29
diff --git a/quantum/template/avr/readme.md b/quantum/template/avr/readme.md
index d243c66a9..719222d37 100644
--- a/quantum/template/avr/readme.md
+++ b/quantum/template/avr/readme.md
@@ -4,7 +4,7 @@
4 4
5A short description of the keyboard/project 5A short description of the keyboard/project
6 6
7Keyboard Maintainer: [You](https://github.com/yourusername) 7Keyboard Maintainer: [%YOUR_NAME%](https://github.com/yourusername)
8Hardware Supported: The PCBs, controllers supported 8Hardware Supported: The PCBs, controllers supported
9Hardware Availability: links to where you can find this hardware 9Hardware Availability: links to where you can find this hardware
10 10
diff --git a/quantum/template/avr/template.c b/quantum/template/avr/template.c
index 3deeae88b..1e4ce26cd 100644
--- a/quantum/template/avr/template.c
+++ b/quantum/template/avr/template.c
@@ -1,4 +1,4 @@
1/* Copyright 2019 REPLACE_WITH_YOUR_NAME 1/* Copyright 2019 %YOUR_NAME%
2 * 2 *
3 * This program is free software: you can redistribute it and/or modify 3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by 4 * it under the terms of the GNU General Public License as published by
diff --git a/quantum/template/base/keymaps/default/config.h b/quantum/template/base/keymaps/default/config.h
index c8e433412..44382016a 100644
--- a/quantum/template/base/keymaps/default/config.h
+++ b/quantum/template/base/keymaps/default/config.h
@@ -1,4 +1,4 @@
1/* Copyright 2019 REPLACE_WITH_YOUR_NAME 1/* Copyright 2019 %YOUR_NAME%
2 * 2 *
3 * This program is free software: you can redistribute it and/or modify 3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by 4 * it under the terms of the GNU General Public License as published by
diff --git a/quantum/template/base/keymaps/default/keymap.c b/quantum/template/base/keymaps/default/keymap.c
index 11cd134a0..482a44544 100644
--- a/quantum/template/base/keymaps/default/keymap.c
+++ b/quantum/template/base/keymaps/default/keymap.c
@@ -1,4 +1,4 @@
1/* Copyright 2019 REPLACE_WITH_YOUR_NAME 1/* Copyright 2019 %YOUR_NAME%
2 * 2 *
3 * This program is free software: you can redistribute it and/or modify 3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by 4 * it under the terms of the GNU General Public License as published by
diff --git a/quantum/template/base/template.h b/quantum/template/base/template.h
index caf2abb4c..5b5076c47 100644
--- a/quantum/template/base/template.h
+++ b/quantum/template/base/template.h
@@ -1,4 +1,4 @@
1/* Copyright 2019 REPLACE_WITH_YOUR_NAME 1/* Copyright 2019 %YOUR_NAME%
2 * 2 *
3 * This program is free software: you can redistribute it and/or modify 3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by 4 * it under the terms of the GNU General Public License as published by
diff --git a/quantum/template/ps2avrgb/template.c b/quantum/template/ps2avrgb/template.c
index 4e35a2c12..08156c562 100644
--- a/quantum/template/ps2avrgb/template.c
+++ b/quantum/template/ps2avrgb/template.c
@@ -1,4 +1,4 @@
1/* Copyright 2019 REPLACE_WITH_YOUR_NAME 1/* Copyright 2019 %YOUR_NAME%
2 * 2 *
3 * This program is free software: you can redistribute it and/or modify 3 * This program is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by 4 * it under the terms of the GNU General Public License as published by
diff --git a/util/new_project.sh b/util/new_project.sh
index d1d1ed82c..9dec714b0 100755
--- a/util/new_project.sh
+++ b/util/new_project.sh
@@ -43,7 +43,11 @@ GIT=$(whereis git)
43if [ "$GIT" != "" ]; then 43if [ "$GIT" != "" ]; then
44 IS_GIT_REPO=$($GIT log >>/dev/null 2>&1; echo $?) 44 IS_GIT_REPO=$($GIT log >>/dev/null 2>&1; echo $?)
45 if [ "$IS_GIT_REPO" -eq 0 ]; then 45 if [ "$IS_GIT_REPO" -eq 0 ]; then
46 ID="'$($GIT config --get user.name)'" 46 ID="$($GIT config --get user.name)"
47 read -rp "What is your name? [$ID] " YOUR_NAME
48 if [ -n "$YOUR_NAME" ]; then
49 ID=$YOUR_NAME
50 fi
47 echo "Using $ID as user name" 51 echo "Using $ID as user name"
48 52
49 for i in "$NEW_KBD/config.h" \ 53 for i in "$NEW_KBD/config.h" \
@@ -52,7 +56,7 @@ if [ "$GIT" != "" ]; then
52 "$NEW_KBD/keymaps/default/config.h" \ 56 "$NEW_KBD/keymaps/default/config.h" \
53 "$NEW_KBD/keymaps/default/keymap.c" 57 "$NEW_KBD/keymaps/default/keymap.c"
54 do 58 do
55 awk -v id="$ID" '{sub(/REPLACE_WITH_YOUR_NAME/,id); print}' < "$i" > "$i.$$" 59 awk -v id="$ID" '{sub(/%YOUR_NAME%/,id); print}' < "$i" > "$i.$$"
56 mv "$i.$$" "$i" 60 mv "$i.$$" "$i"
57 done 61 done
58 fi 62 fi