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-primaries/getting-started/environment-setup/windows-setup.md
+41-40Lines changed: 41 additions & 40 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,9 +17,9 @@ It is highly recommended to follow everything in order!
17
17
This is a source-control application that is very useful for sharing projects with many files.
18
18
19
19
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)
23
23
24
24
### __Create GitHub account__
25
25
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
32
32
{: .callout-red}
33
33
34
34
1. Go to the [ut-ras RobotathonESP32 repository hosted on GitHub](https://github.com/ut-ras/RobotathonESP32)
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)
41
41
42
42
### __Set Up Git SSH Authentication__
43
43
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`
51
51
{: .callout-blue}
52
52
53
53
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.
57
57
58
58
{: .highlight}
59
59
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.
60
60
{: .callout-blue}
61
61
62
62
#### Add SSH key to SSH-agent
63
63
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
65
65
66
66
#### Add SSH key to Github
67
67
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
69
69
70
70
{: .highlight}
71
71
The key should look something like `ssh-ed25519 SFNJNAFNEJKFNJNJKNFJHFJAHOHiowuroiuwr/sfjeher+KX/rH [email protected]`
72
72
{: .callout-blue}
73
73
74
74
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. 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)
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
94
94
95
95
### __Install USB-UART Bridge Driver__
96
96
This allows your computer to recognize and program your ESP32 when you plug it in.
97
97
98
98
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
102
102
103
103
### __Install 7-zip__
104
104
7-zip is a file compression tool that works much faster than your native Windows tools.
105
105
106
106
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
109
109
110
110
### __Install Preconfigured VS Code__
111
111
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.
112
112
113
113
{: .highlight}
114
114
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}
116
116
117
117
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
119
119
{: .highlight}
120
120
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)
121
121
{: .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)
0 commit comments