Skip to content

Fix Ubuntu build-from-source documentation referencing non-existent files #847

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

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
+26 −8
Draft

Fix Ubuntu build-from-source documentation referencing non-existent files #847

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
667b422
Initial plan
Copilot Mar 27, 2026
95c858d
Fix ubuntu build documentation: replace non-existent cmake/DownloadOn…
Copilot Mar 27, 2026
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
34 changes: 26 additions & 8 deletions pages/src/pages/dev/ubuntu.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,21 @@ Welcome! This guide will walk you through setting up your development environmen
Open your terminal and run:

```sh
sudo apt install build-essential zsh cmake git curl zip unzip tar
sudo apt install build-essential zsh cmake ninja-build git curl zip unzip tar python3 python3-pip
```

Then add the OBS Studio PPA and install the required OBS and Qt6 development packages:

```sh
sudo add-apt-repository ppa:obsproject/obs-studio
sudo apt-get update
sudo apt-get install -y \
libgles2-mesa-dev \
libqt6svg6-dev \
libsimde-dev \
obs-studio \
qt6-base-dev \
qt6-base-private-dev
```

---
Expand Down Expand Up @@ -55,27 +69,29 @@ export VCPKG_ROOT=~/vcpkg
This step may take 10–20 minutes:

```sh
${VCPKG_ROOT}/vcpkg install --triplet x64-linux-obs
${VCPKG_ROOT}/vcpkg install --x-install-root=./.deps_vendor/vcpkg_installed --triplet x64-linux-obs
```

---

## 5. Download ONNX Runtime
## 5. Build ONNX Runtime

Use CMake to download ONNX Runtime:
Install Python build requirements, then build ONNX Runtime from source (this may take a significant amount of time):

```sh
cmake -P cmake/DownloadOnnxruntime.cmake
pip install --user -r requirements-build.txt
./scripts/build_ort_ubuntu.sh
```

---

## 6. Build the Project

Build using the provided CI scripts:
Configure and build using the provided CMake preset:

```sh
./.github/scripts/build-ubuntu --target ubuntu-x86_64 --config RelWithDebInfo
cmake --preset ubuntu-x86_64
cmake --build --preset ubuntu-x86_64
```

---
Expand All @@ -95,7 +111,9 @@ sudo cmake --install build_x86_64
Create a Debian package:

```sh
./.github/scripts/package-ubuntu --target ubuntu-x86_64 --config RelWithDebInfo --package
cd build_x86_64
cpack -G DEB
cd ..
```

---
Expand Down