Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Windows getting started setup instructions #43

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/cmake/zmk_config.cmake
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ if (BASE_KEYMAPS_DIR)
if (EXISTS "${KEYMAP_DIR}/include")
include_directories("${KEYMAP_DIR}/include")
endif()
list(APPEND ZMK_DTC_FILES "${KEYMAP_DIR}/keymap.overlay")
list(APPEND ZMK_DTC_FILES "${KEYMAP_DIR}keymap.overlay")
endif()

if (ZMK_CONFIG)
Expand Down
25 changes: 24 additions & 1 deletion docs/docs/dev-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,24 @@ 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

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).

Expand Down Expand Up @@ -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:

Unix:
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if this is the best way to split up Windos/Unix. Would be nice to have tabs to click on like in the Zephyr docs.

```
source zephyr/zephyr-env.sh
```

Windows:
```
source zephyr/zephyr-env.cmd
```

#### All Shells

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.

*Skip on Windows*
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure where else to put this.


##### Bash

```
Expand Down