Skip to content

Commit e7e40c0

Browse files
committed
i sure hope this drop down doesnt break
1 parent 8a59a0a commit e7e40c0

File tree

1 file changed

+31
-60
lines changed
  • docs/_sections/_guide-primaries/getting-started/environment-setup

1 file changed

+31
-60
lines changed

docs/_sections/_guide-primaries/getting-started/environment-setup/windows-setup.md

Lines changed: 31 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -103,8 +103,39 @@ This allows your computer to recognize and program your ESP32 when you plug it i
103103
4. Agree and use default configuration
104104

105105
### __Install VS Code and ESP-IDF Extension__
106+
106107
VS Code is an easily customizable IDE with many extensions and a large community, meaning you can easiy find solutions to any issues that may arise :)
107108

109+
{: .highlight}
110+
If your Windows username has spaces in it, then you will need to use the following guide in lieu of the steps below to install VS Code! This is because ESP-IDF cannot install properly if the install path contains spaces, so the following is our workaround :)
111+
{: .callout-red}
112+
113+
<details markdown="1">
114+
<summary>Click to expand</summary>
115+
### __Install 7-zip__
116+
7-zip is a file compression tool that works much faster than your native Windows tools.
117+
118+
1. Go to the [7-zip download page](https://www.7-zip.org/)
119+
2. Install using defaults
120+
3. Launch 7-zip
121+
122+
### __Install Preconfigured VS Code__
123+
The preconfigured version allows you to circumvent the issue of not being able to install ESP-IDF if your Windows username has whitespace in it (ESP-IDF refuses to install if that is the case). This is a (in my humble opinion) a better solution than creating an entirely new account on your computer
124+
125+
1. Download [zip folder from Box (~3.1 GB)](https://utexas.box.com/shared/static/0f8jo5nuhbsmefy4jkklvslvlj38f2bz.zip)
126+
2. Unzip the file to your C: drive using 7-zip. [(How do I use 7-zip?)](https://ut-ras.github.io/RobotathonESP32/technical#how-do-i-use-7-zip)
127+
{: .highlight}
128+
This **will** take a while if you don't use 7-zip
129+
{: .callout-red}
130+
131+
3. Launch the "containerized" VS Code by running the `Code.exe` file in the unzipped folder
132+
4. In the top menu bar of VS Code, click `File` > `Open Folder`
133+
5. Use VS Code to open the folder where you cloned the Robotathon repository (“RobotathonESP32” by default)
134+
6. Wait for the ESP-IDF extension to initialize
135+
7. Build the project by clicking the wrench icon in the bottom ribbon of VS Code (this will take a while the first time)
136+
<img src="{{ '/_assets/images/vscode_bottom_ribbon_build.png' | prepend: site.baseurl }}" alt="vscode_bottom_ribbon_build.png :(">
137+
</details>
138+
108139
1. Download and install [VS Code](https://code.visualstudio.com/download)
109140
2. Open the extensions tab and search `ESP-IDF`
110141
TODO put picture
@@ -128,66 +159,6 @@ TODO put picture
128159

129160

130161

131-
132-
<details>
133-
<summary>Click to expand</summary>
134-
135-
This is the content that will be hidden until expanded.
136-
137-
- You can use **Markdown** inside
138-
- Lists, code blocks, images all work
139-
- Even multiple paragraphs
140-
141-
</details>
142-
143-
144-
145-
146-
147-
148-
149-
TODO move this to FAQ ???
150-
151-
152-
### __Install 7-zip__
153-
7-zip is a file compression tool that works much faster than your native Windows tools.
154-
155-
1. Go to the [7-zip download page](https://www.7-zip.org/)
156-
2. Install using defaults
157-
3. Launch 7-zip
158-
159-
### __Install Preconfigured VS Code__
160-
The preconfigured version allows you to circumvent the issue of not being able to install ESP-IDF if your Windows username has whitespace in it (ESP-IDF refuses to install if that is the case). This is a (in my humble opinion) a better solution than creating an entirely new account on your computer
161-
162-
1. Download [zip folder from Box (~3.1 GB)](https://utexas.box.com/shared/static/0f8jo5nuhbsmefy4jkklvslvlj38f2bz.zip)
163-
2. Unzip the file to your C: drive using 7-zip. [(How do I use 7-zip?)](https://ut-ras.github.io/RobotathonESP32/technical#how-do-i-use-7-zip)
164-
{: .highlight}
165-
This **will** take a while if you don't use 7-zip
166-
{: .callout-red}
167-
168-
3. Launch the "containerized" VS Code by running the `Code.exe` file in the unzipped folder
169-
4. In the top menu bar of VS Code, click `File` > `Open Folder`
170-
5. Use VS Code to open the folder where you cloned the Robotathon repository (“RobotathonESP32” by default)
171-
6. Wait for the ESP-IDF extension to initialize
172-
7. Build the project by clicking the wrench icon in the bottom ribbon of VS Code (this will take a while the first time)
173-
<img src="{{ '/_assets/images/vscode_bottom_ribbon_build.png' | prepend: site.baseurl }}" alt="vscode_bottom_ribbon_build.png :(">
174-
175-
176-
177-
178-
179-
180-
181-
182-
183-
184-
185-
186-
187-
188-
189-
190-
191162
### __Flash your ESP32__
192163

193164
1. Plug in your ESP32

0 commit comments

Comments
 (0)