Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

delete devcontainer #34181

Merged
merged 2 commits into from
Dec 8, 2024
Merged

delete devcontainer #34181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5f8b02
remove
maxime-desroches Dec 8, 2024
cf8e992
Update tools/README.md
maxime-desroches Dec 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions .devcontainer/.gitignore
View file
Open in desktop

This file was deleted.

18 changes: 0 additions & 18 deletions .devcontainer/Dockerfile
View file
Open in desktop

This file was deleted.

38 changes: 0 additions & 38 deletions .devcontainer/container_post_create.sh
View file
Open in desktop

This file was deleted.

15 changes: 0 additions & 15 deletions .devcontainer/container_post_start.sh
View file
Open in desktop

This file was deleted.

53 changes: 0 additions & 53 deletions .devcontainer/devcontainer.json
View file
Open in desktop

This file was deleted.

47 changes: 0 additions & 47 deletions .devcontainer/host_setup
View file
Open in desktop

This file was deleted.

10 changes: 0 additions & 10 deletions .devcontainer/host_setup.cmd
View file
Open in desktop

This file was deleted.

54 changes: 0 additions & 54 deletions .github/workflows/tools_tests.yaml
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion release/release_files.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@

".git/",
".github/",
".devcontainer/",
"Darwin/",
".vscode",

Expand Down
12 changes: 1 addition & 11 deletions tools/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

openpilot is developed and tested on **Ubuntu 24.04**, which is the primary development target aside from the [supported embedded hardware](https://github.com/commaai/openpilot#running-on-a-dedicated-device-in-a-car).

Running natively on any other system is not recommended and will require modifications. On Windows you can use WSL, and on macOS or incompatible Linux systems, it is recommended to use the dev containers.
Most of openpilot should work natively on macOS. On Windows you can use WSL for a nearly native Ubuntu experience. Running natively on any other system is not currently recommended and will likely require modifications.

## Native setup on Ubuntu 24.04

Expand Down Expand Up @@ -48,16 +48,6 @@ source .venv/bin/activate
scons -u -j$(nproc)
```

## Dev Container on any Linux or macOS

openpilot supports [Dev Containers](https://containers.dev/). Dev containers provide customizable and consistent development environment wrapped inside a container. This means you can develop in a designated environment matching our primary development target, regardless of your local setup.

Dev containers are supported in [multiple editors and IDEs](https://containers.dev/supporting), including Visual Studio Code. Use the following [guide](https://code.visualstudio.com/docs/devcontainers/containers) to start using them with VSCode.

#### X11 forwarding on macOS

GUI apps like `ui` or `cabana` can also run inside the container by leveraging X11 forwarding. To make use of it on macOS, additional configuration steps must be taken. Follow [these](https://gist.github.com/sorny/969fe55d85c9b0035b0109a31cbcb088) steps to setup X11 forwarding on macOS.

## WSL on Windows

[Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about) should provide a similar experience to native Ubuntu. [WSL 2](https://docs.microsoft.com/en-us/windows/wsl/compare-versions) specifically has been reported by several users to be a seamless experience.
Expand Down
Loading