From 4086ac966dc726a350c173d529572bec506be753 Mon Sep 17 00:00:00 2001 From: Nick Coutsos Date: Mon, 6 Mar 2023 21:20:25 -0500 Subject: Add instruction for local configuration --- running-locally.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/running-locally.md b/running-locally.md index 985ee54..671a634 100644 --- a/running-locally.md +++ b/running-locally.md @@ -6,7 +6,9 @@ already cloned onto your computer. ## Setup 1. Clone this repo and open the new directory in a terminal. -3. Clone a `zmk-config`\* repo. Either create symlinks in this directory to the +2. Copy `.env.template` to `.env`. You can fill in this file as appropriate, but + this is enough to get started. +4. Clone a `zmk-config`\* repo. Either create symlinks in this directory to the cloned repositories or clone them into this directory if you must. 3. Run `npm install` 4. Run `npm run dev` @@ -32,4 +34,4 @@ Click the _Save Local_ button to save the modified keymap back to your local zmk-config repo. From here you can commit and push those changes to your remote on GitHub to trigger the build. -[zmk-config-corne-demo]: https://github.com/nickcoutsos/zmk-config-corne-demo \ No newline at end of file +[zmk-config-corne-demo]: https://github.com/nickcoutsos/zmk-config-corne-demo -- cgit v1.2.3