diff options
| author | fauxpark <fauxpark@gmail.com> | 2017-12-09 16:36:32 +1100 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2017-12-09 10:46:11 -0500 |
| commit | 7b0356d1d49da6574570e110f61f95692afdb3d0 (patch) | |
| tree | a3e70802085ea8089f1e7851529f0296247fa264 /docs/hardware_keyboard_guidelines.md | |
| parent | 6eb89ae906db7f226570e1839b88dcdd3a8fa962 (diff) | |
| download | qmk_firmware-7b0356d1d49da6574570e110f61f95692afdb3d0.tar.gz qmk_firmware-7b0356d1d49da6574570e110f61f95692afdb3d0.zip | |
Convert all headings to Title Case
Diffstat (limited to 'docs/hardware_keyboard_guidelines.md')
| -rw-r--r-- | docs/hardware_keyboard_guidelines.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/hardware_keyboard_guidelines.md b/docs/hardware_keyboard_guidelines.md index 8b16a13c9..fcc3b75ce 100644 --- a/docs/hardware_keyboard_guidelines.md +++ b/docs/hardware_keyboard_guidelines.md | |||
| @@ -2,7 +2,7 @@ | |||
| 2 | 2 | ||
| 3 | We welcome all keyboard projects into QMK, but ask that you try to stick to a couple guidelines that help us keep things organised and consistent. | 3 | We welcome all keyboard projects into QMK, but ask that you try to stick to a couple guidelines that help us keep things organised and consistent. |
| 4 | 4 | ||
| 5 | ## Naming your keyboard/project | 5 | ## Naming Your Keyboard/Project |
| 6 | 6 | ||
| 7 | All names should be lowercase alphanumeric, and separated by an underscore (`_`), but not begin with one. Your directory and your `.h` and `.c` files should have exactly the same name. All folders should follow the same format. | 7 | All names should be lowercase alphanumeric, and separated by an underscore (`_`), but not begin with one. Your directory and your `.h` and `.c` files should have exactly the same name. All folders should follow the same format. |
| 8 | 8 | ||
| @@ -10,7 +10,7 @@ All names should be lowercase alphanumeric, and separated by an underscore (`_`) | |||
| 10 | 10 | ||
| 11 | All projects need to have a `readme.md` file that explains what the keyboard is, who made it, where it is available, and links to more information. Please follow the [published template](documentation_templates.md#keyboard-readmemd-template). | 11 | All projects need to have a `readme.md` file that explains what the keyboard is, who made it, where it is available, and links to more information. Please follow the [published template](documentation_templates.md#keyboard-readmemd-template). |
| 12 | 12 | ||
| 13 | ## Image/Hardware files | 13 | ## Image/Hardware Files |
| 14 | 14 | ||
| 15 | In an effort to keep the repo size down, we're no longer accepting images of any format in the repo, with few exceptions. Hosting them elsewhere (imgur) and linking them in the `readme.md` is the preferred method. | 15 | In an effort to keep the repo size down, we're no longer accepting images of any format in the repo, with few exceptions. Hosting them elsewhere (imgur) and linking them in the `readme.md` is the preferred method. |
| 16 | 16 | ||
| @@ -95,7 +95,7 @@ All key positions and rotations are specified in relation to the top-left corner | |||
| 95 | * **Important**: These are relative to the top-left of the key, not absolute. | 95 | * **Important**: These are relative to the top-left of the key, not absolute. |
| 96 | * Example ISO Enter: `[ [0,0], [1.5,0], [1.5,2], [0.25,2], [0.25,1], [0,1], [0,0] ]` | 96 | * Example ISO Enter: `[ [0,0], [1.5,0], [1.5,2], [0.25,2], [0.25,1], [0,1], [0,0] ]` |
| 97 | 97 | ||
| 98 | ### How Is The Metadata Exposed? | 98 | ### How is the Metadata Exposed? |
| 99 | 99 | ||
| 100 | This metadata is primarily used in two ways: | 100 | This metadata is primarily used in two ways: |
| 101 | 101 | ||
| @@ -104,11 +104,11 @@ This metadata is primarily used in two ways: | |||
| 104 | 104 | ||
| 105 | Configurator authors can see the [QMK Compiler](https://docs.compile.qmk.fm/api_docs.html) docs for more information on using the JSON API. | 105 | Configurator authors can see the [QMK Compiler](https://docs.compile.qmk.fm/api_docs.html) docs for more information on using the JSON API. |
| 106 | 106 | ||
| 107 | ## Non-production/handwired projects | 107 | ## Non-Production/Handwired Projects |
| 108 | 108 | ||
| 109 | We're happy to accept any project that uses QMK, including prototypes and handwired ones, but we have a separate `/keyboards/handwired/` folder for them, so the main `/keyboards/` folder doesn't get overcrowded. If a prototype project becomes a production project at some point in the future, we'd be happy to move it to the main `/keyboards/` folder! | 109 | We're happy to accept any project that uses QMK, including prototypes and handwired ones, but we have a separate `/keyboards/handwired/` folder for them, so the main `/keyboards/` folder doesn't get overcrowded. If a prototype project becomes a production project at some point in the future, we'd be happy to move it to the main `/keyboards/` folder! |
| 110 | 110 | ||
| 111 | ## Warnings as errors | 111 | ## Warnings as Errors |
| 112 | 112 | ||
| 113 | When developing your keyboard, keep in mind that all warnings will be treated as errors - these small warnings can build-up and cause larger errors down the road (and keeping them is generally a bad practice). | 113 | When developing your keyboard, keep in mind that all warnings will be treated as errors - these small warnings can build-up and cause larger errors down the road (and keeping them is generally a bad practice). |
| 114 | 114 | ||
| @@ -132,6 +132,6 @@ The core of QMK is licensed under the [GNU General Public License](https://www.g | |||
| 132 | 132 | ||
| 133 | If your keyboard makes use of the [uGFX](https://ugfx.io) features within QMK you must comply with the [uGFX License](https://ugfx.io/license.html), which requires a separate commercial license before selling a device containing uGFX. | 133 | If your keyboard makes use of the [uGFX](https://ugfx.io) features within QMK you must comply with the [uGFX License](https://ugfx.io/license.html), which requires a separate commercial license before selling a device containing uGFX. |
| 134 | 134 | ||
| 135 | ## Technical details | 135 | ## Technical Details |
| 136 | 136 | ||
| 137 | If you're looking for more information on making your keyboard work with QMK, [check out the hardware section](hardware.md)! | 137 | If you're looking for more information on making your keyboard work with QMK, [check out the hardware section](hardware.md)! |
