kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add Windows setup instructions

Browse source
This commit is contained in:
Nick 2020-06-30 21:00:14 -05:00
parent 4c5ed99381
commit 3aeee33e1f
2 changed files with 25 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
app/cmake/zmk_config.cmake
View file

@ -83,7 +83,7 @@ if (BASE_KEYMAPS_DIR)
if (EXISTS "${KEYMAP_DIR}/include") if (EXISTS "${KEYMAP_DIR}/include")
include_directories("${KEYMAP_DIR}/include") include_directories("${KEYMAP_DIR}/include")
endif() endif()
list(APPEND ZMK_DTC_FILES "${KEYMAP_DIR}/keymap.overlay") list(APPEND ZMK_DTC_FILES "${KEYMAP_DIR}keymap.overlay")
endif() endif()
if (ZMK_CONFIG) if (ZMK_CONFIG)

25
docs/docs/dev-setup.md
View file

@ -69,9 +69,24 @@ TODO
TODO TODO
### Windows
Use `cmd.exe` with these instructions rather than PowerShell.
Chocolatey is recommended and used for the following instructions. You can manually install each of these applications and add them to your `PATH` if you don't want to use Chocolatey.
1. [Install Chocolatey](https://chocolatey.org/install)
2. Open `cmd.exe` as **Administrator**
3. Run the following `choco` commands:
```shell
choco install cmake --installargs 'ADD_CMAKE_TO_PATH=System'
choco install ninja gperf python git
```
4. Close your `cmd.exe` session and open a new non-administrator session for the rest of the setup.
### WSL ### WSL
Windows Subsystem for Linux can use various Linux distributions. Find a WSL installation on the [Windows Store](https://aka.ms/wslstore). Windows Subsystem for Linux can use various Linux distributions. Find a WSL installation on the [Windows Store](https://aka.ms/wslstore). **Note that flashing from WSL is not supported at the moment.**
After installing your preferred flavor, follow the directions above on [Debian/Ubuntu](#debianubuntu) or [Fedora](#fedora). After installing your preferred flavor, follow the directions above on [Debian/Ubuntu](#debianubuntu) or [Fedora](#fedora).
@ -166,15 +181,23 @@ We suggest two main [options](https://docs.zephyrproject.org/latest/guides/env_v
To load the Zephyr environment properly for just one transient shell, run the following from your ZMK checkout directory: To load the Zephyr environment properly for just one transient shell, run the following from your ZMK checkout directory:
Unix:
``` ```
source zephyr/zephyr-env.sh source zephyr/zephyr-env.sh
``` ```
Windows:
```
source zephyr/zephyr-env.cmd
```
#### All Shells #### All Shells
To load the environment variables for your shell every time, To load the environment variables for your shell every time,
append the existing `~/.zephyrrc` file to your shell's RC file and then start a new shell. append the existing `~/.zephyrrc` file to your shell's RC file and then start a new shell.
*Skip on Windows*
##### Bash ##### Bash
``` ```