Skip to content

Commit

Permalink
GitBook: [qmk#24] No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
SamyPesse authored and gitbook-bot committed Dec 22, 2021
1 parent 872df91 commit 8c25ced
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,24 @@

[![Current Version](https://img.shields.io/github/tag/qmk/qmk\_firmware.svg)](/~https://github.com/qmk/qmk\_firmware/tags) [![Build Status](https://travis-ci.org/qmk/qmk\_firmware.svg?branch=master)](https://travis-ci.org/qmk/qmk\_firmware) [![Discord](https://img.shields.io/discord/440868230475677696.svg)](https://discord.gg/Uq7gcHh) [![Docs Status](https://img.shields.io/badge/docs-ready-orange.svg)](https://docs.qmk.fm) [![GitHub contributors](https://img.shields.io/github/contributors/qmk/qmk\_firmware.svg)](/~https://github.com/qmk/qmk\_firmware/pulse/monthly) [![GitHub forks](https://img.shields.io/github/forks/qmk/qmk\_firmware.svg?style=social\&label=Fork)](/~https://github.com/qmk/qmk\_firmware/)

## What is QMK Firmware?
<details>

Hello world 23-export (test staging)

exporting with a new database, and then importing it
<summary>What is QMK Firmware?</summary>

QMK (_Quantum Mechanical Keyboard_) is an open source community that maintains QMK Firmware, QMK Toolbox, qmk.fm, and these docs. QMK Firmware is a keyboard firmware based on the [tmk\_keyboard](http://github.com/tmk/tmk\_keyboard) with some useful features for Atmel AVR controllers, and more specifically, the [OLKB product line](http://olkb.com), the [ErgoDox EZ](http://www.ergodox-ez.com) keyboard, and the [Clueboard product line](http://clueboard.co). It has also been ported to ARM chips using ChibiOS. You can use it to power your own hand-wired or custom keyboard PCB.

## How to Get It
</details>

<details>

<summary>How to Get It</summary>

If you plan on contributing a keymap, keyboard, or features to QMK, the easiest thing to do is [fork the repo through Github](/~https://github.com/qmk/qmk\_firmware#fork-destination-box), and clone your repo locally to make your changes, push them, then open a [Pull Request](/~https://github.com/qmk/qmk\_firmware/pulls) from your fork.

Otherwise, you can clone it directly with `git clone /~https://github.com/qmk/qmk_firmware`. Do not download the zip or tar files; a git repository is required to download the submodules in order to compile.

</details>

## How to Compile

Before you are able to compile, you'll need to [install an environment](detailed-guides/getting\_started\_build\_tools.md) for AVR or/and ARM development. Once that is complete, you'll use the `make` command to build a keyboard and keymap with the following notation:
Expand Down

0 comments on commit 8c25ced

Please sign in to comment.