uhk/firmware
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge branch 'master' of github.com:UltimateHackingKeyboard/firmware

Browse Source
This commit is contained in:
László Monda
2017-06-16 16:00:00 +02:00
parent a27a2645ba bfd574b3e0
commit 1dcfcafdcc
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
CONTRIBUTING.md
View File

@@ -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;
```
@@ -70,7 +72,7 @@ while (condition) {
## Function declaration
```
void do_this()
void doThis()
{
...
}
@@ -123,4 +125,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).

6
README.md
View File

@@ -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