Skip to content

Commit 29199ad

Browse files
shvmmkbx81
andauthored
Update instructions for ESPHome development on Windows (#43)
Co-authored-by: Keith Burzinski <kbx81x@gmail.com>
1 parent adbb419 commit 29199ad

File tree

1 file changed

+24
-2
lines changed

1 file changed

+24
-2
lines changed

docs/contributing/development-environment.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ In short, ESPHome is set up to use a Python virtual environment.
77
This guide will walk you through the steps to set up an environment you can use for development.
88

99
!!!note
10-
These instructions that follow apply for Linux and macOS. Windows users can still develop ESPHome and its
11-
components, but the process is slightly different and not covered (yet) in this guide.
10+
The instructions that follow apply for Linux and macOS. Windows users can still develop ESPHome and its
11+
components, but the process is slightly different and covered at the bottom of this guide.
1212

1313
## Requirements
1414

@@ -116,3 +116,25 @@ git push -u origin my-new-feature
116116

117117
Once you've pushed your branch, if you wish, you can
118118
[submit your work for integration into ESPHome](submitting-your-work.md).
119+
120+
???+ Windows
121+
122+
## Testing Development Changes on Windows
123+
124+
To test changes when using Windows:
125+
126+
- Create a branch in your remote fork of the main ESPHome GitHub repo
127+
- Install from your fork in the same manner you would
128+
[install ESPHome manually](https://esphome.io/guides/installing_esphome) but with one of the following commands:
129+
130+
```bash
131+
pip install --pre https://github.com/username/esphome/archive/branch.zip
132+
```
133+
OR
134+
```bash
135+
pip install -U git+https://github.com/username/esphome.git@branch --force-reinstall
136+
```
137+
138+
Note that `username` and `branch` are (respectively) your GitHub username and branch name in your ESPHome fork on Github.
139+
140+
The `--force-reinstall` flag is important for testing changes!

0 commit comments

Comments
 (0)