diff options
| author | Nick Brassel | 2024-05-30 04:00:41 +0200 |
|---|---|---|
| committer | GitHub | 2024-05-30 04:00:41 +0200 |
| commit | 6ef97172889ccd5db376b2a9f8825489e24fdac4 (patch) | |
| tree | 334e3bf41c8554d4bee73a140822f95f60eb64e9 /docs/README.md | |
| parent | 395766657ff98a4b1fd0dcba5917557f8acbb9e4 (diff) | |
Vitepress conversion of docs. (#23795)
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 37 |
1 files changed, 0 insertions, 37 deletions
diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 9330f0face..0000000000 --- a/docs/README.md +++ /dev/null @@ -1,37 +0,0 @@ -# Quantum Mechanical Keyboard Firmware - -## What is QMK Firmware? - -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. - -## Get Started - -<div class="flex-container"> - -?> **Basic** [QMK Configurator](newbs_building_firmware_configurator.md) <br> -User friendly graphical interfaces, no programming knowledge required. - -?> **Advanced** [Use The Source](newbs.md) <br> -More powerful, but harder to use. - -</div> - -## Make It Yours - -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). - -## Need help? - -Check out the [support page](support.md) to see how you can get help using QMK. - -## 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) -* [Report a bug](https://github.com/qmk/qmk_firmware/issues/new/choose) -* [Open a Pull Request](contributing.md) |