X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=readme.md;h=6fa67c04743f9ca8ef48c4cb6a16abd828a5a2f4;hb=65faab3b89245f81c50b029ca178aed175d5f330;hp=fbd9203a57ae03855e72c1aa08e4745f268727a5;hpb=13bb6b4b7fdd2b3e419d0f89c93fb980b00eeb9b;p=qmk_firmware.git diff --git a/readme.md b/readme.md index fbd9203a5..6fa67c047 100644 --- a/readme.md +++ b/readme.md @@ -14,8 +14,7 @@ For an easy-to-read version of this document and the repository, check out [http * [Preonic](/keyboards/preonic/) * [Atomic](/keyboards/atomic/) * [ErgoDox EZ](/keyboards/ergodox_ez/) -* [Clueboard rev.1](/keyboards/clueboard1/) -* [Clueboard rev.2](/keyboards/clueboard2/) +* [Clueboard](/keyboards/clueboard/) * [Cluepad](/keyboards/cluepad/) The project also includes community support for [lots of other keyboards](/keyboards/). @@ -51,7 +50,7 @@ Before you are able to compile, you'll need to install an environment for AVR de 4. Clone this repository. [This link will download it as a zip file, which you'll need to extract.](https://github.com/jackhumbert/qmk_firmware/archive/master.zip) Open the extracted folder in Windows Explorer. 5. Double-click on the 1-setup-path-win batch script to run it. You'll need to accept a User Account Control prompt. Press the spacebar to dismiss the success message in the command prompt that pops up. 6. Right-click on the 2-setup-environment-win batch script, select "Run as administrator", and accept the User Account Control prompt. This part may take a couple of minutes, and you'll need to approve a driver installation, but once it finishes, your environment is complete! -7. Future build commands should be run from the standard Windows command prompt, which you can find by searching for "command prompt" from the start menu or start screen. Ignore the "MHV AVR Shell". +7. Future build commands should be run from the MHV AVR Shell, which sets up an environment compatible with colorful build output. The standard Command Prompt will also work, but add `COLOR=false` to the end of all make commands when using it. ### Mac If you're using [homebrew,](http://brew.sh/) you can use the following commands: @@ -85,7 +84,7 @@ If you have any problems building the firmware, you can try using a tool called 3. To confirm that you're in the correct location, you can display the contents of your current folder using the `dir` command on Windows, or the `ls` command on Linux or Mac. You should see several files, including `readme.md` and a `quantum` folder. From here, you need to navigate to the appropriate folder under `keyboards/`. For example, if you're building for a Planck, run `cd keyboards/planck`. 4. Once you're in the correct keyboard-specific folder, run the `make` command. This should output a lot of information about the build process. More information about the `make` command can be found below. -# Customizing, building, and flashing your keymap +# Customizing your keymap In every keymap folder, the following files are recommended: @@ -215,7 +214,7 @@ For a value of `4` for this imaginary setting. So we `undef` it first, then `def You can then override any settings, rather than having to copy and paste the whole thing. -## Editing your keymap +## Going beyond the keycodes Aside from the [basic keycodes](doc/keycode.txt), your keymap can include shortcuts to common operations. @@ -564,7 +563,7 @@ You can currently send 4 hex digits with your OS-specific modifier key (RALT for Enable the backlight from the Makefile. -# Custom Quantum functions for keyboards and keymaps +# Custom Quantum functions All of these functions are available in the `*_kb()` or `*_user()` variety. `kb` ones should only be used in the `/.c` file, and `user` ones should only be used in the `keymap.c`. The keyboard ones call the user ones - it's necessary to keep these calls to allow the keymap functions to work correctly. @@ -613,8 +612,9 @@ This gets called whenever there is a state change on your host LEDs (eg caps loc and can be tested against the `usb_led` with a conditional like `if (usb_led & (1<