From e3ebae521e0113edf09f7f3825435d03525b6920 Mon Sep 17 00:00:00 2001 From: Reed Swiernik Date: Fri, 24 Apr 2015 18:28:03 -0400 Subject: Updated readme with new build info --- keyboard/planck/README.md | 31 ++++++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) (limited to 'keyboard/planck/README.md') diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md index 1b76c559a7..d59956d925 100644 --- a/keyboard/planck/README.md +++ b/keyboard/planck/README.md @@ -18,13 +18,31 @@ If you include extended_keymap_common.h instead of keymap_common.h at the top of ## Build -Follow [this guide](http://deskthority.net/workshop-f7/how-to-build-your-very-own-keyboard-firmware-t7177.html) to setup your development environment before anything else. +Follow [this guide](http://deskthority.net/workshop-f7/how-to-build-your-very-own-keyboard-firmware-t7177.html) to setup your development environment before anything else. Abbreviated instructions are provide at the [bottom of this document](https://github.com/rswiernik/tmk_keyboard/tree/rswiernik_dev/keyboard/planck#environment-setup) -Download the whole firmware [here](https://github.com/jackhumbert/tmk_keyboard/archive/master.zip) and navigate to the keyboard/planck folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex that you can load with the Teensy app onto your Planck (once you've hit reset/shorted GND & RST). +Download the whole firmware [here](https://github.com/jackhumbert/tmk_keyboard/archive/master.zip) and navigate to the keyboard/planck folder. Once your dev env is setup, you'll be able to type `make` to generate your .hex that you can load with the Teensy app onto your Planck (once you've hit reset/shorted GND & RST). -Move to this directory then just run `make` like: +Depending on which keymap you would like to use, you will have to compile slightly differently. - $ make +**Extended Keymaps (default)** +Extended keymaps need to be specified as follows: +``` +$ make KEYMAP=[common|jack|] +``` +Applicable keymaps should follow the format **__extended\_keymap\_name.c__** + +**Common Keymaps** +Common keymaps need to be specified as follows: +``` +$ make KEYMAP=[common|jack|] COMMON=true +``` +Applicable keymaps should follow the format **__keymap\_name.c__** + + +To build the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows: +``` +$ make +``` ## Keymap Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_.c` and see keymap document (you can find in top README.md) and existent keymap files. @@ -37,4 +55,7 @@ To build firmware binary hex file with a certain keymap just do `make` with `KEY - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck) - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c) - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck) -- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid) \ No newline at end of file +- [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid) + +## Environment Setup + -- cgit v1.2.3 From c85f68d9cd2963e0a00dfe05fea75b824d5f4fcc Mon Sep 17 00:00:00 2001 From: Reed Swiernik Date: Fri, 24 Apr 2015 18:29:50 -0400 Subject: Update README.md Changed formatting mistake --- keyboard/planck/README.md | 2 ++ 1 file changed, 2 insertions(+) (limited to 'keyboard/planck/README.md') diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md index d59956d925..b106fd8c4d 100644 --- a/keyboard/planck/README.md +++ b/keyboard/planck/README.md @@ -25,6 +25,7 @@ Download the whole firmware [here](https://github.com/jackhumbert/tmk_keyboard/a Depending on which keymap you would like to use, you will have to compile slightly differently. **Extended Keymaps (default)** + Extended keymaps need to be specified as follows: ``` $ make KEYMAP=[common|jack|] @@ -32,6 +33,7 @@ $ make KEYMAP=[common|jack|] Applicable keymaps should follow the format **__extended\_keymap\_name.c__** **Common Keymaps** + Common keymaps need to be specified as follows: ``` $ make KEYMAP=[common|jack|] COMMON=true -- cgit v1.2.3 From 835207193a8d5c366d783c8953d4aeaee5ee094a Mon Sep 17 00:00:00 2001 From: Reed Swiernik Date: Fri, 24 Apr 2015 18:35:57 -0400 Subject: Update README.md Updated formatting again... --- keyboard/planck/README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) (limited to 'keyboard/planck/README.md') diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md index b106fd8c4d..84d5000bb4 100644 --- a/keyboard/planck/README.md +++ b/keyboard/planck/README.md @@ -24,7 +24,13 @@ Download the whole firmware [here](https://github.com/jackhumbert/tmk_keyboard/a Depending on which keymap you would like to use, you will have to compile slightly differently. -**Extended Keymaps (default)** +####Default +To build the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows: +``` +$ make +``` + +####**Extended Keymaps** Extended keymaps need to be specified as follows: ``` @@ -32,7 +38,7 @@ $ make KEYMAP=[common|jack|] ``` Applicable keymaps should follow the format **__extended\_keymap\_name.c__** -**Common Keymaps** +####**Common Keymaps** Common keymaps need to be specified as follows: ``` @@ -40,12 +46,6 @@ $ make KEYMAP=[common|jack|] COMMON=true ``` Applicable keymaps should follow the format **__keymap\_name.c__** - -To build the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows: -``` -$ make -``` - ## Keymap Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_.c` and see keymap document (you can find in top README.md) and existent keymap files. -- cgit v1.2.3 From d0391d9ed7d74e0a6cbf82db1700e7eaa456d386 Mon Sep 17 00:00:00 2001 From: Reed Swiernik Date: Fri, 24 Apr 2015 18:36:57 -0400 Subject: Update README.md This stupid readme... --- keyboard/planck/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'keyboard/planck/README.md') diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md index 84d5000bb4..0e573652e4 100644 --- a/keyboard/planck/README.md +++ b/keyboard/planck/README.md @@ -36,7 +36,7 @@ Extended keymaps need to be specified as follows: ``` $ make KEYMAP=[common|jack|] ``` -Applicable keymaps should follow the format **__extended\_keymap\_name.c__** +Applicable keymaps should follow the format **__extended\_keymap\_.c__** ####**Common Keymaps** @@ -44,7 +44,7 @@ Common keymaps need to be specified as follows: ``` $ make KEYMAP=[common|jack|] COMMON=true ``` -Applicable keymaps should follow the format **__keymap\_name.c__** +Applicable keymaps should follow the format **__keymap\_.c__** ## Keymap Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_.c` and see keymap document (you can find in top README.md) and existent keymap files. -- cgit v1.2.3 From 79f70b20d993f92c676112986b1d137109b35ce7 Mon Sep 17 00:00:00 2001 From: Reed Swiernik Date: Fri, 24 Apr 2015 18:49:49 -0400 Subject: Update README.md Switched around more readme stuff --- keyboard/planck/README.md | 20 ++++++++------------ 1 file changed, 8 insertions(+), 12 deletions(-) (limited to 'keyboard/planck/README.md') diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md index 0e573652e4..8931b5fccf 100644 --- a/keyboard/planck/README.md +++ b/keyboard/planck/README.md @@ -25,33 +25,29 @@ Download the whole firmware [here](https://github.com/jackhumbert/tmk_keyboard/a Depending on which keymap you would like to use, you will have to compile slightly differently. ####Default -To build the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows: +To build with the default keymap, simply move to the tmk\_keyboard/keyboard/planck/ and run `make` as follows: ``` $ make ``` +## Keymap +Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_.c` and see keymap document (you can find in top README.md) and existent keymap files. + ####**Extended Keymaps** -Extended keymaps need to be specified as follows: +To build the firmware binary hex file with an extended keymap just do `make` with `KEYMAP` option like: ``` $ make KEYMAP=[common|jack|] ``` -Applicable keymaps should follow the format **__extended\_keymap\_.c__** +_The only applicable keymaps will work with this option._ Extended keymaps follow the format **__extended\_keymap\_\.c__** ####**Common Keymaps** -Common keymaps need to be specified as follows: +Building with a common keymap is as simple as adding the COMMON option. Note that only ``` $ make KEYMAP=[common|jack|] COMMON=true ``` -Applicable keymaps should follow the format **__keymap\_.c__** - -## Keymap -Several version of keymap are available in advance but you are recommended to define your favorite layout yourself. To define your own keymap create file named `keymap_.c` and see keymap document (you can find in top README.md) and existent keymap files. - -To build firmware binary hex file with a certain keymap just do `make` with `KEYMAP` option like: - - $ make KEYMAP=[] +_The only applicable keymaps will work with this option._ Common keymaps follow the format **__keymap\_\.c__** ## Notable TMK forks (which some of the keymap files are from) - [Shane's Fork](https://github.com/shanecelis/tmk_keyboard/tree/master/keyboard/planck) -- cgit v1.2.3 From eadb08b113e26468a7915d1ea60a3f166527c3b0 Mon Sep 17 00:00:00 2001 From: Reed Swiernik Date: Fri, 24 Apr 2015 18:54:03 -0400 Subject: Update README.md --- keyboard/planck/README.md | 3 --- 1 file changed, 3 deletions(-) (limited to 'keyboard/planck/README.md') diff --git a/keyboard/planck/README.md b/keyboard/planck/README.md index 8931b5fccf..ee824d26e0 100644 --- a/keyboard/planck/README.md +++ b/keyboard/planck/README.md @@ -54,6 +54,3 @@ _The only applicable keymaps will work with this option._ Common keymaps follow - [Pierre's Fork](https://github.com/pcarrier/tmk_keyboard/blob/pcarrier/planck/keyboard/gh60/keymap_planck.c) - [Nathan's Fork](https://github.com/nathanrosspowell/tmk_keyboard/tree/planck-jack/keyboard/planck) - [Matthew's Fork](https://github.com/pepers/tmk_keyboard/tree/master/keyboard/planck_grid) - -## Environment Setup - -- cgit v1.2.3