andrejl
/
qmk-dactyl-manuform-a
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
qmk-dactyl-manuform-a/docs/README.md

44 lines
2.6 KiB
Markdown
Raw Normal View History

convert docs to lowercase and underscores
2017-06-10 20:58:24 +02:00
# Quantum Mechanical Keyboard Firmware
Use docsfy to replace gitbook
2018-05-08 06:58:50 +02:00
[![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?
convert docs to lowercase and underscores
2017-06-10 20:58:24 +02:00
Rework the newbs guide around the qmk cli
2020-02-21 00:50:50 +01:00
QMK (*Quantum Mechanical Keyboard*) is an open source community centered around developing computer input devices. The community encompasses all sorts of input devices, such as keyboards, mice, and MIDI devices. A core group of collaborators maintains [QMK Firmware](https://github.com/qmk/qmk_firmware), [QMK Configurator](https://config.qmk.fm), [QMK Toolbox](https://github.com/qmk/qmk_toolbox), [qmk.fm](https://qmk.fm), and this documentation with the help of community members like you.
convert docs to lowercase and underscores
2017-06-10 20:58:24 +02:00
rework the index page
2020-02-20 22:09:37 +01:00
## Get Started
convert docs to lowercase and underscores
2017-06-10 20:58:24 +02:00
rework the index page
2020-02-20 22:09:37 +01:00
Totally new to QMK? There are two ways to get started:
convert docs to lowercase and underscores
2017-06-10 20:58:24 +02:00
rework the index page
2020-02-20 22:09:37 +01:00
* Basic: [QMK Configurator](https://config.qmk.fm)
* Just select your keyboard from the dropdown and program your keyboard.
* We have an [introductory video](https://www.youtube.com/watch?v=-imgglzDMdY) you can watch.
Rework the newbs guide around the qmk cli
2020-02-21 00:50:50 +01:00
* There is also an overview [document you can read](newbs_building_firmware_configurator.md).
rework the index page
2020-02-20 22:09:37 +01:00
* Advanced: [Use The Source](newbs.md)
* More powerful, but harder to use
convert docs to lowercase and underscores
2017-06-10 20:58:24 +02:00
rework the index page
2020-02-20 22:09:37 +01:00
## Make It Yours
convert docs to lowercase and underscores
2017-06-10 20:58:24 +02:00
[Docs] Update links in main README.md (#11284) It looks like features.md was deprecated and content was split into other files. This results in a broken link on the main page which, if removed, would have no impact to the remainder of the documentation. This would also: resolve #9239 resolve #10293 resolve #10447
2020-12-23 07:37:01 +01:00
QMK has lots of features to explore, and a good deal of reference documentation to dig through. Most features are taken advantage of by modifying your [keymap](keymap.md), and changing the [keycodes](keycodes.md).
Rework the newbs guide around the qmk cli
2020-02-21 00:50:50 +01:00
## Need help?
make sure all our redirects are in order
2020-03-01 17:57:26 +01:00
Check out the [support page](support.md) to see how you can get help using QMK.
Rework the newbs guide around the qmk cli
2020-02-21 00:50:50 +01:00
## Give Back
There are a lot of ways you can contribute to the QMK Community. The easiest way to get started is to use it and spread the word to your friends.
* Help people out on our forums and chat rooms:
* [/r/olkb](https://www.reddit.com/r/olkb/)
* [Discord Server](https://discord.gg/Uq7gcHh)
* Contribute to our documentation by clicking "Edit This Page" at the bottom
* [Translate our documentation into your language](translating.md)
Add more call to action items
2020-03-01 06:17:17 +01:00
* [Report a bug](https://github.com/qmk/qmk_firmware/issues/new/choose)
* [Open a Pull Request](contributing.md)