# qmk_distro_msys

**Repository Path**: Showman_yip/qmk_distro_msys

## Basic Information

- **Project Name**: qmk_distro_msys
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-17
- **Last Updated**: 2024-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# QMK MSYS

> A Windows one-click installer for the QMK CLI

[![Latest Release](https://img.shields.io/github/v/release/qmk/qmk_distro_msys?color=3D87CE&label=Latest&sort=semver&style=for-the-badge)](https://github.com/qmk/qmk_distro_msys/releases/latest)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/qmk/qmk_distro_msys/build.yml?logo=github&style=for-the-badge)](https://github.com/qmk/qmk_distro_msys/actions?query=workflow%3ACI+branch%3Amain)
[![Discord](https://img.shields.io/discord/440868230475677696.svg?logo=discord&logoColor=white&color=7289DA&style=for-the-badge)](https://discord.gg/Uq7gcHh)

Want to get started with [QMK Firmware](https://qmk.fm) quickly? Running Windows 8/10 and want to avoid installation headaches? Look no further!

Bundling MSYS2 + QMK CLI together, this installer package aims to give you a QMK build environment with as little effort as possible.

![terminal example](./docs/.vuepress/public/terminal.png)

## Documentation

1. Install the [latest release](https://github.com/qmk/qmk_distro_msys/releases/latest)
1. Open the `QMK MSYS` shortcut
1. Run [`qmk setup`](https://docs.qmk.fm/#/newbs_getting_started?id=set-up-qmk)
1. Run [`qmk compile`](https://docs.qmk.fm/#/newbs_getting_started?id=_4-test-your-build-environment)
1. Profit!

Full documentation is available at <https://msys.qmk.fm/>.

## Official Website

[qmk.fm](https://qmk.fm) is the official website of QMK, where you can find links to this page, the documentation, and the keyboards supported by QMK.