Git Product home page Git Product logo

qmk_container's Introduction

qmk_container Docker Image CI Generic badge

Dockerfile to generate a container with everything needed to use QMK(Quantum Mechanical Keyboard).
The size of the extracted image is approximately 4.6GB.

Geting the image

OPTION 1: Pulling from Docker Hub (recommended)

docker pull jsanchez0x/qmk_container

OPTION 2: Building the image manually

git clone https://github.com/jsanchez0x/qmk_container.git
docker build --rm --tag jsanchez0x/qmk_container:latest qmk_container

Instructions

1.- Preparing the environment

It is necessary to create some working directories. For example:

mkdir -p $HOME/qmk/firmwares $HOME/qmk/keyboards

2.- Clone QMK firmware repository

You need to have the source code files. You can get them from the official QMK repository (keyboards directory) and copy it into the $HOME/qmk/keyboards directory.

Example for the YMDK Wings PCB:

git clone https://github.com/qmk/qmk_firmware.git
cp -r qmk_firmware/keyboards/ymdk $HOME/qmk/keyboards/

3.- Compiling the firmware

Run the qmk_compile command for execute the compilation in the container. It is recommended to share a directory in order to have the project on the host machine and the compiled firmware is also generated on the host machine.

Following the previous example:

docker run --rm -it \
        --name qmk_container \
        -v $HOME/qmk/keyboards/:/qmk_firmware/keyboards/ \
        -v $HOME/qmk/firmwares/:/qmk_firmware/.build/ \
        jsanchez0x/qmk_container:latest qmk_compile

The keyboard and keymap will be requested. Continuing with the example:

Keyboard (i.e. kbdfans/kbd67/mkiirgb/v2):
ymdk/wings
Keymap (i.e. via):
default

Executing compilation...

More info

More information on how to use this image can be found in the official QMK documentation.

Credits

Official QMK base container

qmk_container's People

Contributors

jsanchez0x avatar dependabot[bot] avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.