From 67900c4e8e4d603224197a222bacae778ac0eb15 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A1szl=C3=B3=20Monda?= Date: Fri, 16 Jun 2017 00:05:13 +0200 Subject: [PATCH 1/3] Create README.md --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 08741cc..c8ac298 100644 --- a/README.md +++ b/README.md @@ -18,11 +18,9 @@ Install [Kinetis Design Studio](http://www.nxp.com/products/software-and-tools/r ## Building and flashing the firmware -*Please substitute vX with v6 or v7 below according to the actual version of your prototype.* +For the left keyboard half, make sure to power it via the right keyboard half (which must be powered via USB). Also connect the left keyboard half to your SEGGER J-Link USB debug probe (which must also be connected via USB). Then in KDS, click on *Run -> Run Configurations*, select *GDB SEGGER J-Link Debugging -> uhk-left release jlink*, and click on the *Debug* button. -For the left keyboard half, make sure to power it via the right keyboard half (which must be powered via USB). Also connect the left keyboard half to your SEGGER J-Link USB debug probe (which must also be connected via USB). Then in KDS, click on *Run -> Run Configurations*, select *GDB SEGGER J-Link Debugging -> uhk-left vX release jlink*, and click on the *Debug* button. - -For the right keyboard half, flash [the bootloader](https://github.com/UltimateHackingKeyboard/bootloader) first. Then in KDS, click on *Run -> Run Configurations*, select *C/C++ Application -> uhk-right vX release kboot*, and click on the *Debug* button. Please note that this update method only works on Linux out of the box. On other operating systems, you have to execute the relevant commands of the [blhost-unix.sh](right/build/kds/blhost-unix.sh) script. +For the right keyboard half, flash [the bootloader](https://github.com/UltimateHackingKeyboard/bootloader) first. Then in KDS, click on *Run -> Run Configurations*, select *C/C++ Application -> uhk-right release blhost*, and click on the *Debug* button. Please note that this update method only works on Linux out of the box. On other operating systems, you have to execute the relevant commands of the [blhost-unix.sh](right/build/kds/blhost-unix.sh) script. ## Contributing From 7472849355a424753190733f29459aa27e5ad919 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A1szl=C3=B3=20Monda?= Date: Fri, 16 Jun 2017 01:00:03 +0200 Subject: [PATCH 2/3] Create CONTRIBUTING.md --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b1a3538..a50c61f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -70,7 +70,7 @@ while (condition) { ## Function declaration ``` -void do_this() +void doThis() { ... } @@ -123,4 +123,4 @@ Header files are composed of sections. The order of sections is fixed. Every hea ## Semantics -The build process must not yield any warnings. +The build process must not yield any warnings, and the build must pass [on Travis](https://travis-ci.org/UltimateHackingKeyboard/firmware). From bfd574b3e055966743217882b587ee5e0e2d17e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?L=C3=A1szl=C3=B3=20Monda?= Date: Fri, 16 Jun 2017 01:01:25 +0200 Subject: [PATCH 3/3] Create CONTRIBUTING.md --- CONTRIBUTING.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a50c61f..73837e4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,9 +14,11 @@ Extern functions and variables are written with UpperCamelCase, non-extern funct Function names are composed of a verb followed by a noun. +Non-extern functions must be declared as static. + ``` DoThisExtern(); -doThisNonExtern(); +static doThisNonExtern(); uint8 ExternVariable; uint8 nonExternVariable; ```