You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/_sections/_guide-FAQ/technical.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -117,3 +117,18 @@ In a similar fashion, Git commands require you to navigate to your Git repositor
117
117
118
118
119
119
## What is the SiLabs USB-UART driver for?
120
+
The SiLabs USB-UART driver is an application that allows your computer to send and receive serial data through a standard USB port by treating the device as a virtual COM port. This is commonly used to connect devices like microcontrollers or other serial-based devices to a computer via USB.
121
+
122
+
It translates USB data into serial data (UART) and vice versa, allowing applications to interact with a connected device (your microcontroller) as if it were a traditional serial port.
123
+
124
+
125
+
## How do I use 7-zip?
126
+
127
+
To extract your zipped VS Code archive, follow these steps:
128
+
1. Locate and click the zipped archive you'd like to extract in the 7-zip file browser
Copy file name to clipboardExpand all lines: docs/_sections/_guide-primaries/getting-started/environment-setup/windows-setup.md
+16-7Lines changed: 16 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,7 @@ Git Bash is finicky and doesn't support Ctrl + V for paste. Use `Shift + Insert`
59
59
1. You will likely be prompted to enter a passcode. Press `Enter` twice to specify no passcode.
60
60
61
61
{: .highlight}
62
-
Note that you can add a passcode if you'd like, but it is not necessary. If you do, keep in mind that the Bash terminal does _not_ show your passcode as you type it out. Just continue (accurately) typing and press `Enter` when done.
62
+
Note that you can add a passcode if you'd like, but it is not recommended. If you do, keep in mind that the Bash terminal does _not_ show your passcode as you type it out. Just continue (accurately) typing and press `Enter` when done.
63
63
{: .callout-blue}
64
64
65
65
#### Add SSH key to SSH-agent
@@ -69,11 +69,17 @@ Note that you can add a passcode if you'd like, but it is not necessary. If you
69
69
#### Add SSH key to Github
70
70
1. Paste `cat ~/.ssh/id_ed25519.pub` into the terminal and press `Enter` to display your public SSH key
71
71
1. Copy the entire key
72
+
{: .highlight}
73
+
The key should look something like `ssh-ed25519 SFNJNAFNEJKFNJNJKNFJHFJAHOHiowuroiuwr/sfjeher+KX/rH [email protected]`
74
+
{: .callout-blue}
72
75
1. Navigate to the upper-right corner of any page on [GitHub](https://github.com/), click your profile photo, then click Settings (gear icon)
1. Paste in the key you copied earlier into the `Key` section
77
83
1. Click `Add SSH Key`
78
84
79
85
### __Clone Forked Repository__
@@ -83,7 +89,7 @@ Cloning is the process of copying a Git repository onto your local computer stor
83
89
84
90
1. Go to the your team's newly forked repository
85
91
1. Click the green `<> Code` button
86
-
1. If you did the previous section, copy the SSH git link. Otherwise copy the HTTPS link. [What is the difference?](TODO write this)
92
+
1. If you did the previous section, copy the SSH git link. Otherwise copy the HTTPS link. [What is the difference?](https://ut-ras.github.io/RobotathonESP32/technical#what-is-the-difference-between-cloning-using-https-and-ssh)
1. Open Git Bash and navigate to where you want to keep your code for the competition, such as your Documents or Desktop. [How do I do that](TODO write this)
89
95
1. Run the following command in your Git terminal `git clone https://github.com/ut-ras/RobotathonESP32.git`
@@ -106,18 +112,21 @@ This step is **optional**, but it will save you at least 30 minutes when unzippi
106
112
7-zip is a file compression tool that works much faster than your native Windows tools.
107
113
108
114
1. Go to the [7-zip download page](https://www.7-zip.org/)
109
-
1. Install using default directory
115
+
1. Install using defaults
110
116
1. Launch 7-zip
111
117
112
118
### __Install Preconfigured VS Code__
113
119
VS Code is an easily customizable IDE with many extensions and a large community. The preconfigured version you will download will already have ESP-IDF installed.
114
120
115
121
{: .highlight}
116
-
Do this even if you already have VS Code to minimize environment setup issues. Installing the ESP-IDF extension manually may result in unecessary debugging.
122
+
Do this even if you already have VS Code to minimize environment setup issues. Installing the ESP-IDF extension manually may result in unecessary debugging.
117
123
{: .callout-red}
118
124
119
125
1. Download zip folder from Box TODO insert box link
120
-
1. Unzip the file to your C: drive (this **will** take a while unless you use 7-zip)
126
+
1. Unzip the file to your C: drive
127
+
{: .highlight}
128
+
This **will** take a while unless you use 7-zip. [How do I use 7-zip?](TODO link)
129
+
{: .callout-red}
121
130
1. Launch the "containerized" VS Code by running the Code.exe file in the unzipped folder
122
131
1. In the top menu bar of VS Code, click `File` > `Open Folder`
123
132
1. Use VS Code to open the folder where you cloned the Robotathon repository (“RobotathonESP32” by default)
0 commit comments