1.6 KiB
| title | sidebar_label |
|---|---|
| Getting Started | Getting Started |
:::info Throughout this documentation you will see commands like
sudo apt update
These commands should be run in a terminal such as Bash (Linux/MacOS/Docker), PowerShell, or Command Prompt (Windows). :::
:::tip We recommend reading through the setup process before following it step by step, to ensure that you are happy with installing the required dependencies. :::
Environment Setup
There are two ways to setup the ZMK development environment:
The Docker approach is a self-contained development environment while the native approach will setup your local operating system for development. It uses the same Docker image which is used by the GitHub action for local development. Beyond the benefits of dev/prod parity, this approach may be easier to set up for some operating systems. No toolchain or dependencies are necessary when using Docker; the container image has the toolchain installed and set up to use.
The native approach installs the toolchain and dependencies on your system directly. This typically runs slightly faster than the Docker approach, and can be preferable for users who already have the dependencies on their system.
Please see the Docker instructions or native instructions to continue setup.