Skip to content

Home

The QMK Tutorial

Your computer keyboard has a processor inside of it, similar to the one inside your computer. This processor runs software that is responsible for detecting button presses and informing the computer when keys are pressed. QMK Firmware fills the role of that software, detecting button presses and passing that information on to the host computer. When you build your custom keymap, you are creating an executable program for your keyboard.

  1. curso_fpga

Your computer keyboard has a processor inside of it, similar to the one inside

  • HTML for content and structure
  • JavaScript for interactivity
  • CSS for text running out of boxes
  • Internet Explorer ... huh?

  • Set up in 5 minutes

    Install mkdocs-material with pip and get up and running in minutes

    Getting started

  • It's just Markdown

    Focus on your content and generate a responsive and searchable static site

    Reference

  • Made to measure

    Change the colors, fonts, language, icons, logo and more with a few lines

    Customization

  • Open Source, MIT

    Material for MkDocs is licensed under MIT and available on [GitHub]

    License

  • Set up in 5 minutes

    Install mkdocs-material with pip and get up and running in minutes

    Getting started

  • It's just Markdown

    Focus on your content and generate a responsive and searchable static site

    Reference

  • Made to measure

    Change the colors, fonts, language, icons, logo and more with a few lines

    Customization

  • Open Source, MIT

    Material for MkDocs is licensed under MIT and available on [GitHub]

    License

\[ \cos x=\sum_{k=0}^{\infty}\frac{(-1)^k}{(2k)!}x^{2k} \]

Your computer keyboard has a processor inside of it, similar to the one inside

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque pharetra nunc eu nibh vulputate, sit amet tempus erat dapibus. Pellentesque non sollicitudin lorem. Mauris quis nisl tortor. Proin faucibus efficitur leo, eu condimentum magna semper non. Ut bibendum tristique eleifend. Curabitur sit amet enim lacus. Curabitur lobortis maximus dui sed viverra. Nunc scelerisque vehicula elementum. Phasellus vitae viverra ante, ac condimentum odio.

Nullam sit amet pharetra purus, sit amet fermentum est. Curabitur ullamcorper, eros ut dictum hendrerit, odio nisl dictum tortor, non scelerisque felis odio eu lorem. Phasellus consequat libero et posuere fermentum. Vivamus commodo urna a nibh dapibus pellentesque. Praesent eu efficitur justo. Vestibulum egestas nec sapien sit amet facilisis. Mauris ullamcorper dignissim rutrum. Vivamus faucibus arcu vitae sem aliquam, eleifend tempus dolor dapibus.

Sed nec purus id diam tincidunt sodales et gravida ipsum. Mauris imperdiet malesuada fermentum. Sed pellentesque orci metus, eu auctor quam iaculis pellentesque. Sed non convallis neque. Duis ut eros dictum, tincidunt enim ut, lacinia lacus. Nulla vel turpis sagittis, gravida magna vel, consequat nisi. Etiam pharetra eleifend est, nec auctor nibh pulvinar in. Duis vitae feugiat nulla. Duis tincidunt consequat consectetur.

Donec in imperdiet nisi, ac feugiat arcu. Cras vel aliquet felis. Praesent ut ante porta, finibus mi a, viverra libero. Aenean id pharetra nulla, sit amet luctus nisi. Sed laoreet pulvinar ex, vel faucibus nisi eleifend a. Nulla mauris mi, efficitur vehicula sollicitudin vel, facilisis id mauris. Praesent sodales dictum ligula eget hendrerit. Praesent non nisl ligula. Nulla at purus tempor, eleifend lacus in, feugiat massa. Nullam neque sapien, finibus eu dignissim at, faucibus et nulla.

Vivamus sagittis eros ac sem facilisis pretium. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Sed dignissim ornare urna quis egestas. Nullam congue eleifend ipsum eget posuere. Maecenas euismod nulla in dui ullamcorper, eget luctus eros iaculis. Etiam faucibus dolor vitae sem gravida, at suscipit enim viverra. Aenean at consequat libero. Phasellus elementum, tortor vitae bibendum interdum, enim nulla ullamcorper odio, vel efficitur ipsum tellus nec ex. Duis ante elit, tincidunt ac nulla et, rhoncus cursus ex. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque pharetra nunc eu nibh vulputate, sit amet tempus erat dapibus. Pellentesque non sollicitudin lorem. Mauris quis nisl tortor. Proin faucibus efficitur leo, eu condimentum magna semper non. Ut bibendum tristique eleifend. Curabitur sit amet enim lacus. Curabitur lobortis maximus dui sed viverra. Nunc scelerisque vehicula elementum. Phasellus vitae viverra ante, ac condimentum odio.

Nullam sit amet pharetra purus, sit amet fermentum est. Curabitur ullamcorper, eros ut dictum hendrerit, odio nisl dictum tortor, non scelerisque felis odio eu lorem. Phasellus consequat libero et posuere fermentum. Vivamus commodo urna a nibh dapibus pellentesque. Praesent eu efficitur justo. Vestibulum egestas nec sapien sit amet facilisis. Mauris ullamcorper dignissim rutrum. Vivamus faucibus arcu vitae sem aliquam, eleifend tempus dolor dapibus.

Sed nec purus id diam tincidunt sodales et gravida ipsum. Mauris imperdiet malesuada fermentum. Sed pellentesque orci metus, eu auctor quam iaculis pellentesque. Sed non convallis neque. Duis ut eros dictum, tincidunt enim ut, lacinia lacus. Nulla vel turpis sagittis, gravida magna vel, consequat nisi. Etiam pharetra eleifend est, nec auctor nibh pulvinar in. Duis vitae feugiat nulla. Duis tincidunt consequat consectetur.

Donec in imperdiet nisi, ac feugiat arcu. Cras vel aliquet felis. Praesent ut ante porta, finibus mi a, viverra libero. Aenean id pharetra nulla, sit amet luctus nisi. Sed laoreet pulvinar ex, vel faucibus nisi eleifend a. Nulla mauris mi, efficitur vehicula sollicitudin vel, facilisis id mauris. Praesent sodales dictum ligula eget hendrerit. Praesent non nisl ligula. Nulla at purus tempor, eleifend lacus in, feugiat massa. Nullam neque sapien, finibus eu dignissim at, faucibus et nulla.

Vivamus sagittis eros ac sem facilisis pretium. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Sed dignissim ornare urna quis egestas. Nullam congue eleifend ipsum eget posuere. Maecenas euismod nulla in dui ullamcorper, eget luctus eros iaculis. Etiam faucibus dolor vitae sem gravida, at suscipit enim viverra. Aenean at consequat libero. Phasellus elementum, tortor vitae bibendum interdum, enim nulla ullamcorper odio, vel efficitur ipsum tellus nec ex. Duis ante elit, tincidunt ac nulla et, rhoncus cursus ex.

mux.sv
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
module mux2_to_1 #(
  parameter Width = 32
) (
  input  [Width-1:0] in1_i,
  input  [Width-1:0] in2_i,
  input              sel_i,
  output [Width-1:0] mux_o
);

  assign mux_o = sel_i ? in2_i : in1_i;

endmodule
mux.sv
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
bool process_record_user(uint16_t keycode, keyrecord_t *record) {
  switch (keycode) {
    case FOO:
      if (record->event.pressed) {
        // Do something when pressed
      } else {
        // Do something else when release
      }
      return false; // Skip all further processing of this key
    case KC_ENTER:
      // Play a tone when enter is pressed
      if (record->event.pressed) {
        PLAY_SONG(tone_qwerty);
      }
      return true; // Let QMK send the enter press/release events
    default:
      return true; // Process all other keycodes normally
  }
}

#include <stdio.h>

int main(void) {
  printf("Hello world!\n");
  return 0;
}

#include <iostream>

int main(void) {
  std::cout << "Hello world!" << std::endl;
  return 0;
}

Example

* Sed sagittis eleifend rutrum
* Donec vitae suscipit est
* Nulla tempor lobortis orci

1. Sed sagittis eleifend rutrum
2. Donec vitae suscipit est
3. Nulla tempor lobortis orci