kofal.net/zmk
1
0
Fork 1
mirror of https://github.com/zmkfirmware/zmk.git synced 2026-03-28 17:05:18 -05:00
Code Issues Packages Projects Releases Wiki Activity

refactor(docs): Refactor the development section (#2438)

Browse Source
This commit is contained in:
Nicolas Munnich
2024-09-02 06:54:19 +02:00
committed by GitHub
parent aae4feeda8
commit 266227b580
33 changed files with 117 additions and 79 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/docs/development/local-toolchain/setup/index.md Normal file
View File

@@ -0,0 +1,20 @@
---
title: Getting Started
sidebar_label: Getting Started
---
:::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 set up the ZMK development environment:
- [Docker](docker.md): \
A self-contained development environment. It uses the same [Docker image which is used by the GitHub action](https://github.com/zmkfirmware/zmk-docker) for local development. Beyond the benefits of [dev/prod parity](https://12factor.net/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.
- [Native](native.mdx):\
This uses your operating system directly. Usually 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](docker.md) instructions or [native](native.mdx) instructions to continue setup.