Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
73 changes: 50 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,56 @@ The name "Vela" is originated from the Latin term for "sail," which is also the
- Please refer to the [Supported Architectures and Platforms](https://nuttx.apache.org/docs/latest/platforms/index.html) page for a complete list.
- For adaptation cases regarding development boards, please refer to the [Case Documentation](./en/dev_board/Development_Board.md).

## What's New

- **Significant Hardware Ecosystem Expansion**: Added support for **Infineon AURIX™ TC4**, **Flagchip MCU**, and the **QEMU-R52 SIL** platform. (View [TC4 Guide](./en/quickstart/development_board/tc4d9_evb_guide.md) / [Flagchip Guide](./en/quickstart/development_board/fc7300f8m_evb_guide.md))

- **Enhanced Ubuntu Development Experience**: The OpenVela VS Code plugin now **fully supports the Ubuntu environment**. Linux developers can enjoy a seamless, end-to-end workflow—from project creation and build to system debugging—significantly boosting development efficiency. Get started: [VS Code Plugin Guide](./en/quickstart/vscode_plugin_usage.md).

## Version Strategy

We manage releases based on the `trunk` branch, using Tags to track release history. This ensures traceability and stability for production environments.

### Release Tags

Release tags are immutable markers created on the `trunk` branch. Each tag represents an officially released version of openvela.

- **Production Environment Recommendation**: To ensure maximum system stability and security, we **strongly recommend** using the latest release tags in production environments (Production Environment), rather than using branch code directly.

### Released Versions

Below are the currently released stable versions and their change logs:

- **trunk-5.4**: Please refer to the [v5.4 Release Notes](./en/release_notes/v5.4.md) for detailed changes.

- **trunk-5.2**: Please refer to the [v5.2 Release Notes](./en/release_notes/v5.2.md) for detailed changes.

### Version Maintenance Strategy

openvela follows a strict version maintenance lifecycle:

- **Patch Updates**: For critical bugs or security vulnerabilities discovered in released versions, the team issues new patch release tags (Patch Release) to provide fixes.
- **Naming Convention**: Patch versions increment based on the original version number, such as `trunk-5.2.1`.

## Branch Strategy

openvela adopts a dual-branch model to balance system innovation and stability. Please select the appropriate branch according to your development needs.

### dev (Development Branch)

- **Definition**: This is the cutting-edge development branch of openvela, aggregating the latest features and bug fixes.
- **Status**: The code updates frequently and remains in a state of continuous integration and rapid iteration. It may contain features not yet fully verified, so potential instability exists.
- **Target Audience**:

- Developers who wish to experience new features early.
- Contributors planning to submit code or participate in core function development.

### trunk (Stable Trunk Branch)

- **Definition**: This is the fully tested main branch, representing the current stable state of the system.
- **Status**: Features from the `dev` branch are merged here only after they pass rigorous testing and verification.
- **Target Audience**: Most users who require high system stability, and engineers developing standard applications.

## Quick start

### Device Development
Expand Down Expand Up @@ -115,29 +165,6 @@ To see the full list of native apps, please visit the [Native App Examples Repos

More Quick App examples are continuously being added. To see all examples, please visit the [Quick App Examples Repository](../../../packages_fe_examples).

## openvela Versioning Strategy

- **dev (Development Branch)**

Contains the latest features and fixes, and may be unstable. Recommended for developers who wish to experience new features or contribute.

- **trunk (Main Stable Branch)**

A comprehensively tested, stable version. Stable features from the `dev` branch are merged here. Recommended for most users seeking stability.

- **Release Tags**

Permanent tags created from the `trunk` branch, representing an official, stable release. We strongly recommend using the latest release tag in **production environments** to ensure maximum stability.

- **List of Released Versions**:

- `trunk-5.2`: For detailed changes in this version, please refer to its [v5.2 Release Notes](./en/release_notes/v5.2.md).
- `trunk-5.4`: For detailed changes in this version, please refer to its [v5.4 Release Notes](./en/release_notes/v5.4.md).

- **Maintenance Policy**:

Critical bug fixes for a released version will be delivered by releasing a new patch tag (e.g., `trunk-5.2.1`).

## Code contribution

- [Code Contribution Guide](./CONTRIBUTING.md)
Expand Down
73 changes: 50 additions & 23 deletions README_zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,56 @@ Vela 的命名源自拉丁语中船帆的含义,也是南方星空中船帆星
- openvela 支持各种不同的架构(ARM32、ARM64、RISC-V、Xtensa、MIPS、CEVA 等)和硬件平台。请在[硬件支持](https://nuttx.apache.org/docs/latest/platforms/index.html)页面上查看完整列表。
- 关于**开发板**的适配案例,请参见[案例文档](./zh-cn/dev_board/Development_Board.md)。

## 最新动态

- 硬件生态大幅扩展:新增对 **英飞凌 AURIX™ TC4**、**旗芯微 (Flagchip) MCU** 以及 **QEMU-R52 SIL** 平台的适配支持。(查看 [TC4 指南](./zh-cn/quickstart/development_board/tc4d9_evb_guide.md) / [旗芯微指南](./zh-cn/quickstart/development_board/fc7300f8m_evb_guide.md))

- Ubuntu 开发体验升级:openvela VS Code 插件现已**完美支持 Ubuntu 环境**。Linux 开发者现在也可以享受从项目创建、编译构建到系统调试的一站式流畅体验,开发效率显著提升。即刻体验:[VS Code 插件使用指南](./zh-cn/quickstart/vscode_plugin_usage.md)。

## 版本发布管理 (Version Strategy)

我们基于 `trunk` 分支进行版本发布,通过标签(Tags)管理发布历史,确保生产环境的可追溯性与稳定性。

### 发布标签 (Release Tags)

发布标签是基于 `trunk` 分支创建的不可变标记(Immutable Marker)。每个标签代表一个正式发布的 openvela 版本。

- **生产环境建议**:为了确保系统的最高稳定性和安全性,我们**强烈建议**在生产环境(Production Environment)中使用最新的发布标签,而非直接使用分支代码。

### 已发布版本列表

以下是当前已发布的稳定版本及其变更说明:

- **trunk-5.4**:请查阅 [v5.4 版本发布说明](./zh-cn/release_notes/v5.4.md) 了解详细变更。

- **trunk-5.2**:请查阅 [v5.2 版本发布说明](./zh-cn/release_notes/v5.2.md) 了解详细变更。

### 版本维护策略

openvela 遵循严格的版本维护生命周期:

- **补丁更新**:针对已发布版本中发现的关键缺陷(Critical Bugs)或安全漏洞,团队将发布新的补丁版本标签(Patch Release)进行修复。
- **命名规则**:补丁版本将在原版本号基础上递增,例如 `trunk-5.2.1`。

## 代码分支管理 (Branch Strategy)

openvela 采用双分支模型来平衡系统的创新性与稳定性。请根据您的开发需求选择合适的分支。

### dev (开发分支)

- **定义**:这是 openvela 的前沿开发分支,汇集了最新的功能特性与缺陷修复。
- **状态**:代码更新频率高,处于持续集成与快速迭代状态,可能包含尚未完全验证的特性,因此可能存在不稳定性。
- **适用人群**:

- 希望抢先体验新功能的开发者。
- 计划向社区提交代码、参与核心功能建设的贡献者。

### trunk (主干稳定分支)

- **定义**:这是经过全面测试的主干分支,代表了当前系统的稳定状态。
- **状态**:`dev` 分支中的功能在经过严格测试验证稳定后,会被合并至此分支。
- **适用人群**:大多数对系统稳定性有较高要求的用户,以及进行标准应用开发的工程师。

## 快速入门

### 设备开发
Expand Down Expand Up @@ -116,29 +166,6 @@ Vela 的命名源自拉丁语中船帆的含义,也是南方星空中船帆星

快应用相关示例正在持续丰富中。查看所有示例,请访问[快应用示例仓库](../../../packages_fe_examples)。

## openvela 版本策略

- **dev (开发分支)**

汇集了最新的功能与修复,可能不稳定。推荐给希望体验新功能或参与贡献的开发者。

- **trunk (主干稳定分支)**

经全面测试的稳定版本,`dev` 分支的稳定功能会合并于此。推荐大多数追求稳定性的用户使用。

- **Release Tags (版本发布标签)**

基于 `trunk` 分支创建的永久标记,代表一个正式、稳定的发布版本。我们强烈建议**生产环境**使用最新的发布标签以确保最高稳定性。

- **已发布版本列表**:

- `trunk-5.2`:关于此版本的详细变更,请查阅其 [v5.2 版本发布说明](./zh-cn/release_notes/v5.2.md)。
- `trunk-5.4`:关于此版本的详细变更,请查阅其 [v5.4 版本发布说明](./zh-cn/release_notes/v5.4.md)。

- **维护策略**:

针对已发布版本的关键 Bug 修复,会通过发布新的补丁版本标签来提供(例如 `trunk-5.2.1`)。

## 参与贡献

- [代码贡献指南](./CONTRIBUTING_zh-cn.md)
Expand Down
2 changes: 1 addition & 1 deletion en/faq/QuickStart_FAQ.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Quick Start FAQ

\[ English | [简体中文](./../../zh-cn/faq/QuickStart_FAQ.md) \]
[ English | [简体中文](./../../zh-cn/faq/QuickStart_FAQ.md) ]

## I. Unable to Access Remote Repository

Expand Down
Loading
Loading