Skip to content

Commit ed876e5

Browse files
committed
added ssh key pictures
1 parent b9d0208 commit ed876e5

File tree

5 files changed

+31
-7
lines changed

5 files changed

+31
-7
lines changed
10.6 KB
Loading
77.4 KB
Loading
40.4 KB
Loading

docs/_sections/_guide-FAQ/technical.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,3 +117,18 @@ In a similar fashion, Git commands require you to navigate to your Git repositor
117117

118118

119119
## 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
129+
<img src="{{ '/_assets/images/locate_7zip.png' | prepend: site.baseurl }}" alt="rmdir :(">
130+
1. Click the `Extract` button at the top of the 7-zip GUI
131+
<img src="{{ '/_assets/images/extract_7ip.png' | prepend: site.baseurl }}" alt="rmdir :(">
132+
1. Set the `Extract to` path to `C:`
133+
<img src="{{ '/_assets/images/path_7zip.png' | prepend: site.baseurl }}" alt="rmdir :(">
134+
1. Click `OK` and wait for the unzipping to finish

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

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Git Bash is finicky and doesn't support Ctrl + V for paste. Use `Shift + Insert`
5959
1. You will likely be prompted to enter a passcode. Press `Enter` twice to specify no passcode.
6060

6161
{: .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.
6363
{: .callout-blue}
6464

6565
#### 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
6969
#### Add SSH key to Github
7070
1. Paste `cat ~/.ssh/id_ed25519.pub` into the terminal and press `Enter` to display your public SSH key
7171
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}
7275
1. Navigate to the upper-right corner of any page on [GitHub](https://github.com/), click your profile photo, then click Settings (gear icon)
76+
<img src="{{ '/_assets/images/github_settings.png' | prepend: site.baseurl }}" alt="my_image.png :(">
7377
1. In the `Access` section of the sidebar, click `SSH and GPG keys`
74-
1. Click `New SSH key or Add SSH key`.
75-
1. Put whatever for the key title name
78+
1. Click the green `New SSH key` button on the right
79+
<img src="{{ '/_assets/images/github_ssh_gpg.png' | prepend: site.baseurl }}" alt="my_image.png :(">
80+
1. Put whatever you want for the key title name
7681
1. Select the key type to be `Authentication`
82+
1. Paste in the key you copied earlier into the `Key` section
7783
1. Click `Add SSH Key`
7884

7985
### __Clone Forked Repository__
@@ -83,7 +89,7 @@ Cloning is the process of copying a Git repository onto your local computer stor
8389

8490
1. Go to the your team's newly forked repository
8591
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)
8793
<img src="{{ '/_assets/images/ssh_link_copy.png' | prepend: site.baseurl }}" alt="my_image.png w=200 h=400 :(">
8894
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)
8995
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
106112
7-zip is a file compression tool that works much faster than your native Windows tools.
107113

108114
1. Go to the [7-zip download page](https://www.7-zip.org/)
109-
1. Install using default directory
115+
1. Install using defaults
110116
1. Launch 7-zip
111117

112118
### __Install Preconfigured VS Code__
113119
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.
114120

115121
{: .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.
117123
{: .callout-red}
118124

119125
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}
121130
1. Launch the "containerized" VS Code by running the Code.exe file in the unzipped folder
122131
1. In the top menu bar of VS Code, click `File` > `Open Folder`
123132
1. Use VS Code to open the folder where you cloned the Robotathon repository (“RobotathonESP32” by default)

0 commit comments

Comments
 (0)