Skip to content

Commit cb2db73

Browse files
authored
Update docs to reflect Ubuntu upgrade (#362)
* Update README to add more instructions for installing code on UTM Ubuntu 22.04 * Update README.md
1 parent 0f1fa87 commit cb2db73

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,15 @@ Some of our dependencies are team-managed, including the CAN library and the H26
1212
Our codebase is developed for an NVIDIA Jetson TX2, which runs Ubuntu Linux; as such, much
1313
of our code will be Unix-specific.
1414

15-
> ⚠️ The only supported platform is Ubuntu 20.04 LTS. Other versions/distros/platforms may work, but if you want as easy as possible, go with this version.
15+
> ⚠️ The only supported platform is Ubuntu 22.04 LTS. Other versions/distros/platforms may work, but if you want as easy as possible, go with this version.
1616
1717
**Windows users:** You should use either [Windows Subsystem for
1818
Linux](https://docs.microsoft.com/en-us/windows/wsl/about) or a VM with a Linux
19-
distribution installed (Ubuntu recommended). Either should work fine. Whichever you use, install either the VM or WSL2 and follow the Linux instructions. As noted above, **use Ubuntu 20.04**.
19+
distribution installed (Ubuntu recommended). Either should work fine. Whichever you use, install either the VM or WSL2 and follow the Linux instructions. As noted above, **use Ubuntu 22.04**.
2020

21-
**Mac users:** We do not make any effort to support Mac systems. You *may* be able to get things working, but if you try you'll be on your own. It's **highly recommended** for Mac users to use a Linux VM.
21+
**Mac users:** We recommend running an Ubuntu virtual machine via [UTM](https://mac.getutm.app/). After installing the app, set up your VM using [UTM's Ubuntu image](https://mac.getutm.app/gallery/ubuntu-20-04). Please note that UTM only supports the latest version of Ubuntu (22.04).
2222

23-
> ⚠️ For Mac users, we recommend running a Ubuntu virtual machine via [UTM](https://mac.getutm.app/). After installing the app, set up your VM using [UTM's Ubuntu image](https://mac.getutm.app/gallery/ubuntu-20-04). Please note that UTM only supports the latest version of Ubuntu (22.04). Since the codebase is based on an older version of Ubuntu, there may be package errors that you need to manually resolve. For the sake of convenience, we also recommend SSHing into UTM via VSCode's Remote SSH feature. [More info can be found here](https://arteen.linux.ucla.edu/ssh-into-utm-vm.html).
24-
25-
**From here on out, the installation instructions will assume you are using Ubuntu 20.04 LTS**. Windows users should run commands in either their Linux VM or their WSL
23+
**From here on out, the installation instructions will assume you are using Ubuntu 22.04 LTS**. Windows users should run commands in either their Linux VM or their WSL
2624
terminal. For Linux users, we'll assume you're running Ubuntu; users of another
2725
distribution may need to change some instructions (e.g. package managers) depending on
2826
your distro.
@@ -41,6 +39,14 @@ cd <place to put repository>
4139
git clone https://github.com/huskyroboticsteam/Resurgence/
4240
```
4341

42+
> You may need to set up a SSH key to clone the repo. You can follow the steps below or find more information [here](https://docs.github.com/en/authentication/connecting-to-github-with-ssh)
43+
44+
> Inside your VM, check if there are existing SSH keys by running `ls -al ~/.ssh`, which will list all files inside your .ssh directory, if they exist. Existing public keys are (by default) one of the following: *id_rsa.pub*, *id_ecdsa.pub*, *id_ed25519.pub*.
45+
46+
> To create a new SSH key, run the following command with your Github email address: `ssh-keygen -t ed25519 -C "github_email@example.com"`. You can accept all of the default configurations.
47+
48+
> To add the SSH key to your GitHub account, run the following command, substituting in for your .pub file: `gh ssh-key add ~/.ssh/<file>.pub -t "UTM Linux" --type signing`
49+
4450
Install dependencies in one go:
4551
```bash
4652
cd Resurgence
@@ -65,6 +71,8 @@ a) Develop within the VM, in which case see "Native Linux" above.
6571
b) Create a shared folder (shared between your computer and VM) and clone the project there. Then use an editor to edit the files on your machine and run them within the VM.
6672

6773
c) Set up the VM as an ssh server (pretty easy) and run VSCode on your machine (not the VM) using the [remote development](https://code.visualstudio.com/docs/remote/ssh) feature.
74+
> For the sake of convenience, we also recommend SSHing into UTM via VSCode's Remote SSH feature. [More info can be found here](https://arteen.linux.ucla.edu/ssh-into-utm-vm.html).
75+
> Remember to run `sudo apt-get install -y openssh-server`.
6876
6977
Of these, (c) probably has the most convenient/usable setup, while (a) is probably the least work.
7078

0 commit comments

Comments
 (0)