Skip to content

Commit bad889b

Browse files
committed
git diagram source and renumbered steps in windows setup
1 parent 2f393ee commit bad889b

File tree

3 files changed

+202
-40
lines changed

3 files changed

+202
-40
lines changed

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

Lines changed: 41 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ It is highly recommended to follow everything in order!
1717
This is a source-control application that is very useful for sharing projects with many files.
1818

1919
1. Go to the [Git website](https://git-scm.com/downloads)
20-
1. Download the 64-bit installer
21-
1. Run the newly downloaded installer and follow the defaults in the installer dialogue
22-
1. Open Git Bash and familiarize yourself with how to navigate the bash terminal [(How do I do that?)](https://ut-ras.github.io/RobotathonESP32/technical#what-is-a-bash-terminal)
20+
2. Download the 64-bit installer
21+
3. Run the newly downloaded installer and follow the defaults in the installer dialogue
22+
4. Open Git Bash and familiarize yourself with how to navigate the bash terminal [(How do I do that?)](https://ut-ras.github.io/RobotathonESP32/technical#what-is-a-bash-terminal)
2323

2424
### __Create GitHub account__
2525
GitHub is a cloud service for saving your Git repositories online. Go to the [GitHub website](https://github.com/) and create an account if you do not have one already.
@@ -32,12 +32,12 @@ Note: only **one** person in each team has to fork the repository and invite the
3232
{: .callout-red}
3333

3434
1. Go to the [ut-ras RobotathonESP32 repository hosted on GitHub](https://github.com/ut-ras/RobotathonESP32)
35-
1. Click the `Fork` button on the right
35+
2. Click the `Fork` button on the right
3636
<img src="{{ '/_assets/images/fork1.png' | prepend: site.baseurl }}" alt="fork1.png :(">
37-
1. Keep the repository name as `RobotathonESP32`
37+
3. Keep the repository name as `RobotathonESP32`
3838
<img src="{{ '/_assets/images/fork2.png' | prepend: site.baseurl }}" alt="fork2.png :(">
39-
1. Click the green `Create fork` button at the bottom
40-
1. Share repository access to your teammates by navigating to the settings of your newly forked repository and clicking collaborators in the left menu [(How do I invite teammates to my forked repository?)](getting-started/git#how-do-i-invite-my-teammates-to-my-forked-repository-on-github)
39+
4. Click the green `Create fork` button at the bottom
40+
5. Share repository access to your teammates by navigating to the settings of your newly forked repository and clicking collaborators in the left menu [(How do 6 invite teammates to my forked repository?)](getting-started/git#how-do-i-invite-my-teammates-to-my-forked-repository-on-github)
4141

4242
### __Set Up Git SSH Authentication__
4343
This allows for easy and secure interfacing with Git when you want to touch your repositories. The SSH keys are a nice way to authenticate your identity with GitHub.
@@ -51,99 +51,100 @@ Git Bash is finicky and doesn't support Ctrl + V for paste. Use `Shift + Insert`
5151
{: .callout-blue}
5252

5353
1. Open Git Bash
54-
1. Paste `ssh-keygen -t ed25519 -C "[email protected]"`, change the email to the one tied to your Github account (keep the quotes), and press `Enter`.
55-
1. You will be prompted to specify a location to save the SSH key. Press `Enter` to specify the default location.
56-
1. You will likely be prompted to enter a passcode. Press `Enter` twice to specify no passcode.
54+
2. Paste `ssh-keygen -t ed25519 -C "[email protected]"`, change the email to the one tied to your Github account (keep the quotes), and press `Enter`.
55+
3. You will be prompted to specify a location to save the SSH key. Press `Enter` to specify the default location.
56+
4. You will likely be prompted to enter a passcode. Press `Enter` twice to specify no passcode.
5757

5858
{: .highlight}
5959
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.
6060
{: .callout-blue}
6161

6262
#### Add SSH key to SSH-agent
6363
1. Paste `eval "$(ssh-agent -s)"` into the terminal and press `Enter` to start the SSH-agent
64-
1. Paste `ssh-add ~/.ssh/id_ed25519` into the terminal and press `Enter` to add your key to the SSH-agent
64+
2. Paste `ssh-add ~/.ssh/id_ed25519` into the terminal and press `Enter` to add your key to the SSH-agent
6565

6666
#### Add SSH key to Github
6767
1. Paste `cat ~/.ssh/id_ed25519.pub` into the terminal and press `Enter` to display your public SSH key
68-
1. Copy the entire key
68+
2. Copy the entire key
6969

7070
{: .highlight}
7171
The key should look something like `ssh-ed25519 SFNJNAFNEJKFNJNJKNFJHFJAHOHiowuroiuwr/sfjeher+KX/rH [email protected]`
7272
{: .callout-blue}
7373

7474
1. Navigate to the upper-right corner of any page on [GitHub](https://github.com/), click your profile photo, then click Settings (gear icon)
7575
<img src="{{ '/_assets/images/github_settings.png' | prepend: site.baseurl }}" alt="my_image.png :(">
76-
1. In the `Access` section of the sidebar, click `SSH and GPG keys`
77-
1. Click the green `New SSH key` button on the right
76+
2. In the `Access` section of the sidebar, click `SSH and GPG keys`
77+
3. Click the green `New SSH key` button on the right
7878
<img src="{{ '/_assets/images/github_ssh_gpg.png' | prepend: site.baseurl }}" alt="my_image.png :(">
79-
1. Put whatever you want for the key title name
80-
1. Select the key type to be `Authentication`
81-
1. Paste in the key you copied earlier into the `Key` section
82-
1. Click `Add SSH Key`
79+
4. Put whatever you want for the key title name
80+
5. Select the key type to be `Authentication`
81+
6. Paste in the key you copied earlier into the `Key` section
82+
7. Click `Add SSH Key`
8383

8484
### __Clone Forked Repository__
8585
Cloning is the process of copying a Git repository onto your local computer storage. Everyone has to do this to work on code!
8686

8787
1. Go to your team's newly forked repository
8888
<img src="{{ '/_assets/images/github_repo.png' | prepend: site.baseurl }}" alt="my_image.png :(">
89-
1. Click the green `<> Code` button
90-
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)
89+
2. Click the green `<> Code` button
90+
3. 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)
9191
<img src="{{ '/_assets/images/ssh_link_copy.png' | prepend: site.baseurl }}" alt="my_image.png w=200 h=400 :(">
92-
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?](https://ut-ras.github.io/RobotathonESP32/technical#how-do-i-navigate-the-git-bash-terminal)
93-
1. Run the following command in your Git terminal: `git clone [PASTE GIT LINK HERE]` without the square brackets
92+
4. 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?](https://ut-ras.github.io/RobotathonESP32/technical#how-do-i-navigate-the-git-bash-terminal)
93+
5. Run the following command in your Git terminal: `git clone [PASTE GIT LINK HERE]` without the square brackets
9494

9595
### __Install USB-UART Bridge Driver__
9696
This allows your computer to recognize and program your ESP32 when you plug it in.
9797

9898
1. Go to [SiLabs installer webpage](https://www.silabs.com/developer-tools/usb-to-uart-bridge-vcp-drivers?tab=downloads)
99-
1. Download the file named `CP210x Windows Drivers`
100-
1. Extract the downloaded zip file and run the appropriate installer application inside (likely x64)
101-
1. Agree and use default configuration
99+
2. Download the file named `CP210x Windows Drivers`
100+
3. Extract the downloaded zip file and run the appropriate installer application inside (likely x64)
101+
4. Agree and use default configuration
102102

103103
### __Install 7-zip__
104104
7-zip is a file compression tool that works much faster than your native Windows tools.
105105

106106
1. Go to the [7-zip download page](https://www.7-zip.org/)
107-
1. Install using defaults
108-
1. Launch 7-zip
107+
2. Install using defaults
108+
3. Launch 7-zip
109109

110110
### __Install Preconfigured VS Code__
111111
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.
112112

113113
{: .highlight}
114114
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.
115-
{: .callout-red}
115+
{: .callout-red}
116116

117117
1. Download [zip folder from Box](https://utexas.box.com/s/2enfprqovfq8kmgcz8d8sn28yr6wpzt4)
118-
1. Unzip the file to your C: drive
118+
2. Unzip the file to your C: drive
119119
{: .highlight}
120120
This **will** take a while unless you use 7-zip. [How do I use 7-zip?](https://ut-ras.github.io/RobotathonESP32/technical#how-do-i-use-7-zip)
121121
{: .callout-blue}
122-
1. Launch the "containerized" VS Code by running the `Code.exe` file in the unzipped folder
123-
1. In the top menu bar of VS Code, click `File` > `Open Folder`
124-
1. Use VS Code to open the folder where you cloned the Robotathon repository (“RobotathonESP32” by default)
125-
1. Wait for the ESP-IDF extension to initialize
126-
1. Build the project by clicking the wrench icon in the bottom ribbon of VS Code (this will take a while the first time)
122+
123+
3. Launch the "containerized" VS Code by running the `Code.exe` file in the unzipped folder
124+
4. In the top menu bar of VS Code, click `File` > `Open Folder`
125+
5. Use VS Code to open the folder where you cloned the Robotathon repository (“RobotathonESP32” by default)
126+
6. Wait for the ESP-IDF extension to initialize
127+
7. Build the project by clicking the wrench icon in the bottom ribbon of VS Code (this will take a while the first time)
127128
<img src="{{ '/_assets/images/vscode_bottom_ribbon_build.png' | prepend: site.baseurl }}" alt="vscode_bottom_ribbon_build.png :(">
128129

129130
### __Flash your ESP32__
130131

131132
1. Plug in your ESP32
132-
1. Click the `COM` button (plug icon) in VS Code’s bottom ribbon menu
133+
2. Click the `COM` button (plug icon) in VS Code’s bottom ribbon menu
133134
<img src="{{ '/_assets/images/vscode_bottom_ribbon_com.png' | prepend: site.baseurl }}" alt="vscode_bottom_ribbon_com.png :(">
134135

135-
1. In the popup dialogue at the top of VS Code, select the COM port labeled `Silicon Labs`
136+
3. In the popup dialogue at the top of VS Code, select the COM port labeled `Silicon Labs`
136137
<img src="{{ '/_assets/images/COM_port.png' | prepend: site.baseurl }}" alt="COM_port.png :(">
137138

138-
1. Click the Flash button (lightning button) in the bottom ribbon menu
139+
4. Click the Flash button (lightning button) in the bottom ribbon menu
139140
<img src="{{ '/_assets/images/vscode_bottom_ribbon_flash.png' | prepend: site.baseurl }}" alt="vscode_bottom_ribbon_flash.png :(">
140141

141-
1. Select UART in the top popup menu
142+
5. Select UART in the top popup menu
142143
<img src="{{ '/_assets/images/UART_selection.png' | prepend: site.baseurl }}" alt="UART_selection.png :(">
143144

144-
1. Press and hold the flash enable button on your ESP32 (small black button labeled “100”) until the following output shows in your terminal:
145+
6. Press and hold the flash enable button on your ESP32 (small black button labeled “100”) until the following output shows in your terminal:
145146

146-
1. Open the serial monitor (monitor/TV icon)
147+
7. Open the serial monitor (monitor/TV icon)
147148
<img src="{{ '/_assets/images/vscode_bottom_ribbon_monitor.png' | prepend: site.baseurl }}" alt="my_image.png :(">
148149

149150
{: .highlight}

docs/_sections/_guide-primaries/getting-started/git.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ parent: Getting Started
66
nav_order: 5
77
---
88

9+
TODO: add diagram showing a main branch and a feature branch
10+
TODO: redo diagrams to be accurate and more understandable
11+
912
# How to use Git:
1013

1114
## What is Git?

0 commit comments

Comments
 (0)