Skip to content

Commit de23bd0

Browse files
shvmmkbx81
andauthored
Update development-environment.md (#56)
Co-authored-by: Keith Burzinski <kbx81x@gmail.com>
1 parent 8e795fd commit de23bd0

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

docs/contributing/development-environment.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This guide will walk you through the steps to set up an environment you can use
1919
!!!note
2020
ESPHome's code and documentation is hosted on [GitHub](https://github.com); we use this to collaborate on all
2121
changes.
22-
22+
2323
As a deep-dive into how `git` and [GitHub](https://github.com) works is beyond the scope of this documentation,
2424
we'll assume that you're already familiar with these tools and just walk through the basic steps required to get
2525
started.
@@ -120,8 +120,13 @@ Once you've pushed your branch, if you wish, you can
120120
???+ Windows
121121

122122
## Testing Development Changes on Windows
123-
124-
To test changes when using Windows:
123+
124+
**In the examples below:**
125+
126+
- `username` is your GitHub username.
127+
- `branch` is the branch name you've used for your work.
128+
129+
**To test changes when using Windows:**
125130

126131
- Create a branch in your remote fork of the main ESPHome GitHub repo
127132
- Install from your fork in the same manner you would
@@ -132,9 +137,14 @@ Once you've pushed your branch, if you wish, you can
132137
```
133138
OR
134139
```bash
135-
pip install -U git+https://github.com/username/esphome.git@branch --force-reinstall
140+
pip install git+https://github.com/username/esphome.git@branch
136141
```
137142

138-
Note that `username` and `branch` are (respectively) your GitHub username and branch name in your ESPHome fork on Github.
143+
- To test changes to the repo without modifying version numbers, a subsequent pip update can be performed using
144+
flags `--no-deps` along with `--force-reinstall` as follows:
145+
146+
```bash
147+
pip install git+https://github.com/username/esphome.git@branch --no-deps --force-reinstall
148+
```
139149

140-
The `--force-reinstall` flag is important for testing changes!
150+
This will ensure that pip only compiles and reinstalls ESPHome and not its dependencies.

0 commit comments

Comments
 (0)