From c81824ee3d37b4df74235176273943d565714817 Mon Sep 17 00:00:00 2001 From: zhangxiaowei16 Date: Wed, 28 Jan 2026 15:03:05 +0800 Subject: [PATCH 1/3] Add the git lfs install command --- en/quickstart/openvela_ubuntu_quick_start.md | 15 ++++++++++++++- zh-cn/quickstart/openvela_ubuntu_quick_start.md | 15 ++++++++++++++- 2 files changed, 28 insertions(+), 2 deletions(-) diff --git a/en/quickstart/openvela_ubuntu_quick_start.md b/en/quickstart/openvela_ubuntu_quick_start.md index 2b63740b..0ff1738a 100644 --- a/en/quickstart/openvela_ubuntu_quick_start.md +++ b/en/quickstart/openvela_ubuntu_quick_start.md @@ -29,8 +29,21 @@ Open a terminal and run the following commands to update the package list and in ```Bash sudo apt update -sudo apt install git git-lfs cmake python3 build-essential +sudo apt install git cmake python3 build-essential +``` + +### 4. Install Git LFS + +> **Note**: This project contains large binary files (e.g., model weights, datasets). You must configure **Git LFS**; **otherwise, the pulled files will be corrupted (appearing as mere text pointers of a few KB) and the project will fail to run.** + +Please run the following commands in your Ubuntu terminal to install and initialize: + +```bash +# Step 1: Configure the official repo and install (ensures the latest version) +curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash +sudo apt-get install git-lfs +# Step 2: Initialize configuration (Important: You must run this, otherwise LFS will not work) git lfs install ``` diff --git a/zh-cn/quickstart/openvela_ubuntu_quick_start.md b/zh-cn/quickstart/openvela_ubuntu_quick_start.md index f419e000..28f14a0e 100644 --- a/zh-cn/quickstart/openvela_ubuntu_quick_start.md +++ b/zh-cn/quickstart/openvela_ubuntu_quick_start.md @@ -29,8 +29,21 @@ ```Bash sudo apt update -sudo apt install git git-lfs cmake python3 build-essential +sudo apt install git cmake python3 build-essential +``` + +### 4. 安装 Git LFS 组件 + +> **说明**：本项目包含大体积的二进制文件（如模型权重、数据集）。请务必配置 **Git LFS**，**否则拉取的文件将损坏（仅显示为几 KB 的指针文本）而无法运行**。 + +请在 Ubuntu 终端中执行以下命令进行安装和初始化： + +```bash +# 第一步：配置官方源并安装 (确保获取最新版) +curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash +sudo apt-get install git-lfs +# 第二步：初始化配置 (重要：必须执行此步，否则 LFS 不会生效) git lfs install ``` From f89bce704e9bba7aff417c6009a427fac2a46f4a Mon Sep 17 00:00:00 2001 From: zhangxiaowei16 Date: Thu, 29 Jan 2026 09:55:09 +0800 Subject: [PATCH 2/3] Add the git lfs install command --- en/quickstart/openvela_ubuntu_quick_start.md | 10 +++++----- zh-cn/quickstart/openvela_ubuntu_quick_start.md | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/en/quickstart/openvela_ubuntu_quick_start.md b/en/quickstart/openvela_ubuntu_quick_start.md index 0ff1738a..3fb7bb3a 100644 --- a/en/quickstart/openvela_ubuntu_quick_start.md +++ b/en/quickstart/openvela_ubuntu_quick_start.md @@ -82,13 +82,13 @@ After installation, you can run `repo --version` to verify it. This method requires you to add your SSH public key to your GitHub account first. Please refer to the [official GitHub documentation](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account). ```bash - repo init -u ssh://git@github.com/open-vela/manifests.git -b trunk -m openvela.xml + repo init -u ssh://git@github.com/open-vela/manifests.git -b trunk -m openvela.xml --git-lfs ``` - Method 2: HTTPS ```bash - repo init -u https://github.com/open-vela/manifests.git -b trunk -m openvela.xml + repo init -u https://github.com/open-vela/manifests.git -b trunk -m openvela.xml --git-lfs ``` #### Option B: Download from Gitee @@ -104,7 +104,7 @@ After installation, you can run `repo --version` to verify it. - Method 2: HTTPS ```bash - repo init -u https://gitee.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ + repo init -u https://gitee.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ --git-lfs ``` #### Option C: Download from GitCode @@ -114,13 +114,13 @@ After installation, you can run `repo --version` to verify it. This method requires you to add your SSH public key to your GitCode account first. Please refer to the [official GitCode documentation](https://docs.gitcode.com/docs/help/home/user_center/security_management/ssh). ```bash - repo init -u ssh://git@gitcode.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ + repo init -u ssh://git@gitcode.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ --git-lfs ``` - Method 2: HTTPS ```bash - repo init -u https://gitcode.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ + repo init -u https://gitcode.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ --git-lfs ``` 3. Execute the sync command. `repo` will download all related source code repositories according to the manifest file (`openvela.xml`). diff --git a/zh-cn/quickstart/openvela_ubuntu_quick_start.md b/zh-cn/quickstart/openvela_ubuntu_quick_start.md index 28f14a0e..38bbcd35 100644 --- a/zh-cn/quickstart/openvela_ubuntu_quick_start.md +++ b/zh-cn/quickstart/openvela_ubuntu_quick_start.md @@ -82,13 +82,13 @@ sudo mv repo /usr/local/bin 此方式需要您先将 SSH 公钥添加至您的 GitHub 账户，请参考 [GitHub 官方文档](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)。 ```bash - repo init -u ssh://git@github.com/open-vela/manifests.git -b trunk -m openvela.xml + repo init -u ssh://git@github.com/open-vela/manifests.git -b trunk -m openvela.xml --git-lfs ``` - 方式二：HTTPS ```bash - repo init -u https://github.com/open-vela/manifests.git -b trunk -m openvela.xml + repo init -u https://github.com/open-vela/manifests.git -b trunk -m openvela.xml --git-lfs ``` #### 选项 B：从 Gitee 下载 @@ -98,13 +98,13 @@ sudo mv repo /usr/local/bin 此方式需要您先将 SSH 公钥添加至您的 Gitee 账户，请参考 [Gitee 官方文档](https://gitee.com/help/articles/4191)。 ```bash - repo init --u ssh://git@gitee.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ + repo init --u ssh://git@gitee.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ --git-lfs ``` - 方式二：HTTPS ```bash - repo init -u https://gitee.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ + repo init -u https://gitee.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ --git-lfs ``` #### 选项 C：从 GitCode 下载 @@ -114,13 +114,13 @@ sudo mv repo /usr/local/bin 此方式需要您先将 SSH 公钥添加至您的 GitCode 账户，请参考 [GitCode 官方文档](https://docs.gitcode.com/docs/help/home/user_center/security_management/ssh)。 ```bash - repo init -u ssh://git@gitcode.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ + repo init -u ssh://git@gitcode.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ --git-lfs ``` - 方式二：HTTPS ```bash - repo init -u https://gitcode.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ + repo init -u https://gitcode.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ --git-lfs ``` 3. 执行同步命令，repo 将根据清单文件 (`openvela.xml`) 下载所有相关的源代码仓库。 From 61348903e4e995224a4701570c612493cdb7a3d1 Mon Sep 17 00:00:00 2001 From: zhangxiaowei16 Date: Thu, 29 Jan 2026 09:57:41 +0800 Subject: [PATCH 3/3] Add the git lfs install command --- en/quickstart/openvela_ubuntu_quick_start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/en/quickstart/openvela_ubuntu_quick_start.md b/en/quickstart/openvela_ubuntu_quick_start.md index 3fb7bb3a..2069eebd 100644 --- a/en/quickstart/openvela_ubuntu_quick_start.md +++ b/en/quickstart/openvela_ubuntu_quick_start.md @@ -98,7 +98,7 @@ After installation, you can run `repo --version` to verify it. This method requires you to add your SSH public key to your Gitee account first. Please refer to the [official Gitee documentation](https://gitee.com/help/articles/4191). ```bash - repo init --u ssh://git@gitee.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ + repo init --u ssh://git@gitee.com/open-vela/manifests.git -b trunk -m openvela.xml --repo-url=https://mirrors.tuna.tsinghua.edu.cn/git/git-repo/ --git-lfs ``` - Method 2: HTTPS