Skip to content

Commit 8a59a0a

Browse files
committed
more setup stuff - transitioning to installing it like normal?
1 parent 6fd5b81 commit 8a59a0a

File tree

3 files changed

+76
-6
lines changed

3 files changed

+76
-6
lines changed

docs/_sections/_guide-home/docs-dev-setup.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,17 @@ nav_order: 1
77

88
<!-- comment the front matter above when not in dev mode -->
99

10+
11+
12+
{: .highlight}
13+
14+
DO NOT USE THIS GUIDE UNLESS YOU ARE CONTRIBUTING TO DOCUMENTATION!! THIS IS ONLY FOR SETTING UP THE JEKYLL DEVELOPMENT ENVIRONMENT
15+
16+
{: .callout-red}
17+
18+
repo link:
19+
https://github.com/ut-ras/RobotathonESP32/tree/robotathon-guide-2025
20+
1021
# windows setup
1122
gl to linux/macos people. its mostly the same so u got it :)
1223

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ nav_order: 3
1212

1313
Setting up a development environment is almost always a pain, but it must be done properly so you can have fun building your robot :)
1414

15-
The exact process depends on what OS your computer is running (Windows, macOS, etc.), so this article will be split into Windows and MacOS setup. If you happen to use another OS, then talk to a mentor for help.
15+
The exact process depends on what OS your computer is running (Windows, macOS, etc.), so this article will be split into Windows and MacOS setup. If you happen to use another OS, then talk to a mentor for help. It is also important to note that you will need around 5 GB of free storage.
1616

1717
The end goal of this section is to flash your ESP32 with an LED blink program. It will take you from having nothing installed to the full coding environment you'll need for the competition!
1818

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

Lines changed: 64 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,53 @@ This allows your computer to recognize and program your ESP32 when you plug it i
102102
3. Extract the downloaded zip file and run the appropriate installer application inside (likely x64)
103103
4. Agree and use default configuration
104104

105+
### __Install VS Code and ESP-IDF Extension__
106+
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 :)
107+
108+
1. Download and install [VS Code](https://code.visualstudio.com/download)
109+
2. Open the extensions tab and search `ESP-IDF`
110+
TODO put picture
111+
3. Download the ESP-IDF extension
112+
TODO put picture
113+
4. Open the setup wizard by clicking the `Configure Extension` button
114+
TODO put picture
115+
5. Click `Express`
116+
TODO put picture
117+
6. Check the box saying `Show all ESP-IDF tags`
118+
TODO put picture
119+
7. Select option `v4.4.8 (release version)`
120+
TODO put picture
121+
8. Ensure the installation paths are valid (i.e. no red warnings) and click the blue `Install` button
122+
9. Wait (this will take a while) :)
123+
10. In the top menu bar of VS Code, click `File` > `Open Folder`
124+
11. Use VS Code to open the folder where you cloned the Robotathon repository (“RobotathonESP32” by default)
125+
12. Wait for the ESP-IDF extension to initialize
126+
13. Build the project by clicking the wrench icon in the bottom ribbon of VS Code (this will take a while the first time)
127+
<img src="{{ '/_assets/images/vscode_bottom_ribbon_build.png' | prepend: site.baseurl }}" alt="vscode_bottom_ribbon_build.png :(">
128+
129+
130+
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+
105152
### __Install 7-zip__
106153
7-zip is a file compression tool that works much faster than your native Windows tools.
107154

@@ -110,11 +157,7 @@ This allows your computer to recognize and program your ESP32 when you plug it i
110157
3. Launch 7-zip
111158

112159
### __Install Preconfigured VS Code__
113-
VS Code is an easily customizable IDE with many extensions and a large community. The preconfigured version you will download will already have the ESP-IDF extension installed for convenience.
114-
115-
{: .highlight}
116-
Do this even if you already have VS Code to minimize environment setup issues. Installing the ESP-IDF extension normally may result in unecessary debugging.
117-
{: .callout-red}
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
118161

119162
1. Download [zip folder from Box (~3.1 GB)](https://utexas.box.com/shared/static/0f8jo5nuhbsmefy4jkklvslvlj38f2bz.zip)
120163
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)
@@ -129,6 +172,22 @@ This **will** take a while if you don't use 7-zip
129172
7. Build the project by clicking the wrench icon in the bottom ribbon of VS Code (this will take a while the first time)
130173
<img src="{{ '/_assets/images/vscode_bottom_ribbon_build.png' | prepend: site.baseurl }}" alt="vscode_bottom_ribbon_build.png :(">
131174

175+
176+
177+
178+
179+
180+
181+
182+
183+
184+
185+
186+
187+
188+
189+
190+
132191
### __Flash your ESP32__
133192

134193
1. Plug in your ESP32

0 commit comments

Comments
 (0)