]> git.donarmstrong.com Git - qmk_firmware.git/blobdiff - docs/adding_a_keyboard_to_qmk.md
Moving LOCK and adding RUN. Fixing equal key to actually use equal keycode.
[qmk_firmware.git] / docs / adding_a_keyboard_to_qmk.md
index 51c4c44109ebb4f30778e65f5fb4ea58c103857c..5ee2c8ccae5802e39ff529eeac3bc5c15e5eec42 100644 (file)
@@ -4,7 +4,7 @@ We welcome all keyboard projects into QMK, but ask that you try to stick to a co
 
 ## Naming your directory/project
 
-All names should be lowercase alphanumeric, and separated by an underscore (`_`), but not begin with one. Dashes (`-`) aren't allow by our build system, and will confuse it with keymaps/subprojects. Your directory and your `.h` and `.c` files should have exactly the same name. Subprojects/revision should follow the same format. 
+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. 
 
 ## `readme.md`
 
@@ -26,7 +26,7 @@ When developing your keyboard, keep in mind that all warnings will be treated as
 
 ## Licenses
 
-If you're adapting your keyboard's setup from another project, but not using the same code, but sure to update the copyright header at the top of the files to show your name, it this format:
+If you're adapting your keyboard's setup from another project, but not using the same code, but sure to update the copyright header at the top of the files to show your name, in this format:
 
     Copyright 2017 Your Name <your@email.com>