update setup instructions

pull/35555/head
Adeeb Shihadeh 6 days ago
parent 4eb64561f2
commit 03f3d6ccf1
  1. 28
      tools/README.md

@ -8,42 +8,26 @@ Most of openpilot should work natively on macOS. On Windows you can use WSL for
## Native setup on Ubuntu 24.04 and macOS ## Native setup on Ubuntu 24.04 and macOS
**1. Clone openpilot** Follow these instructions for a fully managed setup experience. If you'd like to manage the dependencies yourself, just read the setup scripts in this directory.
NOTE: This repository uses Git LFS for large files. Ensure you have [Git LFS](https://git-lfs.com/) installed and set up before cloning or working with it.
Either do a partial clone for faster download: **1. Clone openpilot**
``` bash
git clone --filter=blob:none --recurse-submodules --also-filter-submodules https://github.com/commaai/openpilot.git
```
or do a full clone:
``` bash ``` bash
git clone --recurse-submodules https://github.com/commaai/openpilot.git git clone https://github.com/commaai/openpilot.git
``` ```
**2. Run the setup script** **2. Run the setup script**
``` bash ``` bash
cd openpilot cd openpilot
tools/op.sh setup tools/op.sh setup
``` ```
**3. Git LFS** **3. Activate a Python shell**
``` bash
git lfs pull
```
**4. Activate a python shell**
Activate a shell with the Python dependencies installed: Activate a shell with the Python dependencies installed:
``` bash ``` bash
source .venv/bin/activate source .venv/bin/activate
``` ```
**5. Build openpilot** **4. Build openpilot**
``` bash ``` bash
scons -u -j$(nproc) scons -u -j$(nproc)
``` ```
@ -62,8 +46,6 @@ Learn about the openpilot ecosystem and tools by playing our [CTF](/tools/CTF.md
## Directory Structure ## Directory Structure
``` ```
├── ubuntu_setup.sh # Setup script for Ubuntu
├── mac_setup.sh # Setup script for macOS
├── cabana/ # View and plot CAN messages from drives or in realtime ├── cabana/ # View and plot CAN messages from drives or in realtime
├── camerastream/ # Cameras stream over the network ├── camerastream/ # Cameras stream over the network
├── joystick/ # Control your car with a joystick ├── joystick/ # Control your car with a joystick

Loading…
Cancel
Save