Skip to content

Commit e909f78

Browse files
committed
Merge branch 'newbie-guide-2025' of github.com:ut-ras/RobotathonESP32 into newbie-guide-2025
forgor to pull 💀
2 parents c806713 + 57fbd4e commit e909f78

File tree

1 file changed

+87
-9
lines changed
  • docs/_sections/_guide-primaries/getting-started/environment-setup

1 file changed

+87
-9
lines changed

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

Lines changed: 87 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,99 @@ https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/linux-ma
1616
TODO figure out what to do the setup script installs the CLI for esp-idf isntead of VS Code extension
1717
proly just gona make them go through the install manually
1818

19+
### __Install VSCode__
20+
Download VSCode from the [online download for Mac](https://code.visualstudio.com/download)
1921

22+
### __Installing Git__
23+
This is a source-control application that is very useful for sharing projects with many files.
2024

25+
1. Open the Terminal and type
2126

22-
### Install VS Code
23-
TODO
27+
`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`
2428

25-
### Install Git
26-
TODO
29+
and press `enter`. This will make it extremely easy to install Git.
2730

28-
### Install SiLabs UART-USB driver
29-
1. Go to [SiLabs installer webpage](https://www.silabs.com/developer-tools/usb-to-uart-bridge-vcp-drivers?tab=downloads)
3031

31-
Download the following file:
32-
TODO: add picture
32+
1. Enter `brew install git` to install Git
33+
34+
1. Go to the [GitHub website](https://github.com/) and create an account if you do not have one already.
35+
36+
### __Fork RobotathonESP32 Repository__
37+
Forking a repository creates a copy that you control on your GitHub account. Teams will use our RobotathonESP32 repo as the template.
38+
39+
{: .highlight}
40+
Note: only **one** person in each team has to fork the repository and invite their teammates to it on Github. **Everybody** that wants to code __including the person that forks__ has to clone the repo to their local computer storage!
41+
{: .callout-red}
42+
43+
1. Go to the [ut-ras RobotathonESP32 repository hosted on GitHub](https://github.com/ut-ras/RobotathonESP32)
44+
1. Click the `Fork` button on the right and then click `+ Create a new fork`
45+
<img src="{{ '/_assets/images/github_fork.png' | prepend: site.baseurl }}" alt="my_image.png :(">
46+
1. Change the Repository name to whatever you like
47+
1. Click the green `Create fork` button at the bottom
48+
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?)](TODO WRITE THIS)
49+
50+
### __Set Up Git SSH Authentication__
51+
52+
{: .highlight}
53+
This SSH section is **optional**, but it will make your life easier down the road by letting you push code to your remote repository without manually typing credentials
54+
{: .callout-blue}
55+
56+
See the [official GitHub tutorial](https://docs.github.com/en/enterprise-cloud@latest/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) if you want more information. Otherwise just follow these instructions:
57+
58+
#### Generate SSH key
59+
60+
{: .highlight}
61+
Git Bash is finicky and doesn't support Ctrl + V for paste. Use `Shift + Insert` or `Right Click > Paste` to paste text.
62+
{: .callout-blue}
3363

34-
1. Extract the downloaded zip file and run the appropriate installer application inside
64+
1. Open Git Bash
65+
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`.
66+
1. You will be prompted to specify a location to save the SSH key. Press `Enter` to specify the default location.
67+
1. You will likely be prompted to enter a passcode. Press `Enter` twice to specify no passcode.
68+
69+
{: .highlight}
70+
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.
71+
{: .callout-blue}
72+
73+
#### Add SSH key to SSH-agent
74+
1. Paste `eval "$(ssh-agent -s)"` into the terminal and press `Enter` to start the SSH-agent
75+
1. Paste `ssh-add ~/.ssh/id_ed25519` into the terminal and press `Enter` to add your key to the SSH-agent
76+
77+
#### Add SSH key to Github
78+
1. Paste `cat ~/.ssh/id_ed25519.pub` into the terminal and press `Enter` to display your public SSH key
79+
1. Copy the entire key
80+
{: .highlight}
81+
The key should look something like `ssh-ed25519 SFNJNAFNEJKFNJNJKNFJHFJAHOHiowuroiuwr/sfjeher+KX/rH [email protected]`
82+
{: .callout-blue}
83+
1. Navigate to the upper-right corner of any page on [GitHub](https://github.com/), click your profile photo, then click Settings (gear icon)
84+
<img src="{{ '/_assets/images/github_settings.png' | prepend: site.baseurl }}" alt="my_image.png :(">
85+
1. In the `Access` section of the sidebar, click `SSH and GPG keys`
86+
1. Click the green `New SSH key` button on the right
87+
<img src="{{ '/_assets/images/github_ssh_gpg.png' | prepend: site.baseurl }}" alt="my_image.png :(">
88+
1. Put whatever you want for the key title name
89+
1. Select the key type to be `Authentication`
90+
1. Paste in the key you copied earlier into the `Key` section
91+
1. Click `Add SSH Key`
92+
93+
### __Clone Forked Repository__
94+
Cloning is the process of copying a Git repository onto your local computer storage
95+
96+
97+
1. Go to your team's newly forked repository
98+
<img src="{{ '/_assets/images/github_repo.png' | prepend: site.baseurl }}" alt="my_image.png :(">
99+
1. Click the green `<> Code` button
100+
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)
101+
<img src="{{ '/_assets/images/ssh_link_copy.png' | prepend: site.baseurl }}" alt="my_image.png w=200 h=400 :(">
102+
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)
103+
1. Run the following command in your Git terminal: `git clone [PASTE GIT LINK HERE]` without the square brackets
104+
105+
### __Install USB-UART Bridge Driver__
106+
This allows your computer to recognize and program your ESP32 when you plug it in.
107+
108+
1. Go to [SiLabs installer webpage](https://www.silabs.com/developer-tools/usb-to-uart-bridge-vcp-drivers?tab=downloads)
109+
1. Download the file named `CP210x VCP Mac OSX Driver`
110+
1. Extract the downloaded zip file and open the installer
35111
1. Agree and use default configuration
36112

113+
###__Install ESP-IDF Extension__
114+

0 commit comments

Comments
 (0)