Skip to content

Commit

Permalink
Adjust the docs repository directory structure
Browse files Browse the repository at this point in the history
  • Loading branch information
tanghao-xiaomi committed Dec 27, 2024
1 parent 995aed4 commit 49c0382
Show file tree
Hide file tree
Showing 80 changed files with 56 additions and 47 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ openvela supports a variety of architectures (ARM32, ARM64, RISC-V, Xtensa, MIPS

If you want to experience openvela, we provide a fully functional emulator that can be used without a hardware platform.For more information, refer to the following guide.

1. [Set up the development environment](./Getting_Started/Set_up_the_development_environment.md)
2. [Download openvela source code](./Getting_Started/Download_Vela_sources.md)
3. [Compile openvela source code](./Getting_Started/Build_Vela_from_sources.md)
4. [Run build artifacts on openvela Emulator](./Getting_Started/Run_Vela_on_Vela_Emulator.md)
1. [Set up the development environment](./en/quickstart/Set_up_the_development_environment.md)
2. [Download openvela source code](./en/quickstart/Download_Vela_sources.md)
3. [Compile openvela source code](./en/quickstart/Build_Vela_from_sources.md)
4. [Run build artifacts on openvela Emulator](./en/quickstart/Run_Vela_on_Vela_Emulator.md)

## Sub-repository List

Expand All @@ -53,9 +53,9 @@ If you want to experience openvela, we provide a fully functional emulator that

## Examples

- [Music player](./Examples/Music_Player_Example.md)
- [Smart band](./Examples/Smart_Band_Example.md)
- [Bike computer](./Examples/X_Track.md)
- [Music player](./en/demo/Music_Player_Example.md)
- [Smart band](./en/demo/Smart_Band_Example.md)
- [Bike computer](./en/demo/X_Track.md)

## Code contribution

Expand Down
14 changes: 7 additions & 7 deletions README_zh-cn.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,10 +34,10 @@ openvela 支持各种不同的架构(ARM32、ARM64、RISC-V、Xtensa、MIPS、

如果您想要体验 openvela,我们提供一个功能完备的模拟器,无需硬件平台即可使用。有关详细信息,请参阅如下指南。

1. [准备开发环境](./Getting_Started/Set_up_the_development_environment_zh-cn.md)
2. [下载 openvela 源码](./Getting_Started/Download_Vela_sources_zh-cn.md)
3. [编译 openvela 源码](./Getting_Started/Build_Vela_from_sources_zh-cn.md)
4. [在 openvela Emulator 上运行编译产物](./Getting_Started/Run_Vela_on_Vela_Emulator_zh-cn.md)
1. [准备开发环境](./zh-cn/quickstart/Set_up_the_development_environment_zh-cn.md)
2. [下载 openvela 源码](./zh-cn/quickstart/Download_Vela_sources_zh-cn.md)
3. [编译 openvela 源码](./zh-cn/quickstart/Build_Vela_from_sources_zh-cn.md)
4. [在 openvela Emulator 上运行编译产物](./zh-cn/quickstart/Run_Vela_on_Vela_Emulator_zh-cn.md)

## 子仓库列表

Expand All @@ -53,9 +53,9 @@ openvela 支持各种不同的架构(ARM32、ARM64、RISC-V、Xtensa、MIPS、

## 示例

- [音乐播放器示例](./Examples/Music_Player_Example_zh-cn.md)
- [智能手环示例](./Examples/Smart_Band_Example_zh-cn.md)
- [自行车码表示例](./Examples/X_Track_zh-cn.md)
- [音乐播放器示例](./zh-cn/demo/Music_Player_Example_zh-cn.md)
- [智能手环示例](./zh-cn/demo//Smart_Band_Example_zh-cn.md)
- [自行车码表示例](./zh-cn/demo/X_Track_zh-cn.md)

## 代码贡献

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Demo of music player

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

## Introduction

This article describes how to run the music player demo on openvela Emulator.

## Prerequisites

1. Set up the development environment. Refer to [Environment Setup](../Getting_Started/Set_up_the_development_environment.md).
1. Set up the development environment. Refer to [Environment Setup](./../quickstart/Set_up_the_development_environment.md).

2. Download the source code. Refer to [Download openvela source code](../Getting_Started/Download_Vela_sources.md).
2. Download the source code. Refer to [Download openvela source code](./../quickstart/Download_Vela_sources.md).

## Step 1: Configure the project

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Bandx Demo

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

## Introduction

Expand All @@ -10,9 +10,9 @@ This article describes how to run this example on openvela Emulator.

## Prerequisites

1. Set up the development environment. Refer to [Environment Setup](../Getting_Started/Set_up_the_development_environment.md).
1. Set up the development environment. Refer to [Environment Setup](./../quickstart/Set_up_the_development_environment.md).

2. Download the source code. Refer to [Download openvela source code](../Getting_Started/Download_Vela_sources.md).
2. Download the source code. Refer to [Download openvela source code](./../quickstart/Download_Vela_sources.md).

## Step 1: Configure the project

Expand Down
6 changes: 3 additions & 3 deletions Examples/X_Track.md → en/demo/X_Track.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Example of bike computer

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

## Introduction

Expand All @@ -14,9 +14,9 @@ This article describes how to run the example on openvela Emulator.

## Prerequisites

1. Set up the development environment. Refer to [Environment Setup](../Getting_Started/Set_up_the_development_environment.md).
1. Set up the development environment. Refer to [Environment Setup](./../quickstart/Set_up_the_development_environment.md).

2. Download the source code. Refer to [Download openvela source code](../Getting_Started/Download_Vela_sources.md).
2. Download the source code. Refer to [Download openvela source code](./../quickstart/Download_Vela_sources.md).

## Step 1: Configure the project

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
2 changes: 2 additions & 0 deletions FAQ.md → en/faq/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# FAQ

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

## 1. What language can openvela use to develop applications?

Native programs mainly use C/C++. JavaScript is used for fast apps.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ADB commands

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

ADB is a versatile command-line tool that lets you communicate with a device.With access to the device’s Unix shell, ADB allows you to run a variety of commands on the device.It is a client-server program that includes three components:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Compile the openvela source code

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

## Use build.sh to build openvela

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Debugging with openvela Emulator

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

## Using GDB Console

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Download openvela Source Code

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

The openvela source code is located in a Git repository hosted by [GitHub](https://github.com/open-Vela) or [Gitee](https://gitee.com/open-vela).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Run Build Artifacts on openvela Emulator

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

## Overview of openvela Emulator

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Sending Emulator Console Commands

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

Each running virtual device provides a console that lets you query and control the emulated device environment.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Setting up the Development Environment

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

## Hardware requirements

Expand Down
File renamed without changes
File renamed without changes
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# 音乐播放器Demo

\[ [English](Music_Player_Example.md) | 简体中文 \]
\[ [English](./../../en/demo/Music_Player_Example.md) | 简体中文 \]

## 简介

本文介绍如何在 openvela Emulator 中运行音乐播放器Demo。

## 前提条件

1. 搭建开发环境,请参见[环境搭建](../Getting_Started/Set_up_the_development_environment_zh-cn.md)
1. 搭建开发环境,请参见[环境搭建](../quickstart/Set_up_the_development_environment_zh-cn.md)

2. 下载源码,请参见[下载 openvela 源码](../Getting_Started/Download_Vela_sources_zh-cn.md)
2. 下载源码,请参见[下载 openvela 源码](../quickstart/Download_Vela_sources_zh-cn.md)

## 步骤一 配置项目

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 手环Bandx Demo

\[ [English](Smart_Band_Example.md) | 简体中文 \]
\[ [English](../../en/demo/Smart_Band_Example.md) | 简体中文 \]

## 简介
Bandx 是一款智能手环演示,包括手表表盘、启动器、音乐、心率、秒表、睡眠、运动、设置、手电筒,分辨率为 194*368。可以在 `apps/packages/demos/bandx/` 目录中了解有关 bandx 的更多详细信息。
Expand All @@ -9,9 +9,9 @@ Bandx 是一款智能手环演示,包括手表表盘、启动器、音乐、

## 前提条件

1. 搭建开发环境,请参见[环境搭建](../Getting_Started/Set_up_the_development_environment_zh-cn.md)
1. 搭建开发环境,请参见[环境搭建](../quickstart/Set_up_the_development_environment_zh-cn.md)

2. 下载源码,请参见[下载 openvela 源码](../Getting_Started/Download_Vela_sources_zh-cn.md)
2. 下载源码,请参见[下载 openvela 源码](../quickstart/Download_Vela_sources_zh-cn.md)


## 步骤一 配置项目
Expand Down
6 changes: 3 additions & 3 deletions Examples/X_Track_zh-cn.md → zh-cn/demo/X_Track_zh-cn.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 自行车码表示例

\[ [English](X_Track.md) | 简体中文 \]
\[ [English](../../en/demo/X_Track.md) | 简体中文 \]

## 简介

Expand All @@ -14,9 +14,9 @@

## 前提条件

1. 搭建开发环境,请参见[环境搭建](../Getting_Started/Set_up_the_development_environment_zh-cn.md)
1. 搭建开发环境,请参见[环境搭建](../quickstart/Set_up_the_development_environment_zh-cn.md)

2. 下载源码,请参见[下载 openvela 源码](../Getting_Started/Download_Vela_sources_zh-cn.md)
2. 下载源码,请参见[下载 openvela 源码](../quickstart/Download_Vela_sources_zh-cn.md)

## 步骤一 配置项目

Expand Down
Binary file added zh-cn/demo/images/001.png
Binary file added zh-cn/demo/images/002.png
Binary file added zh-cn/demo/images/003.png
Binary file added zh-cn/demo/images/004.png
Binary file added zh-cn/demo/images/005.png
Binary file added zh-cn/demo/images/006.png
Binary file added zh-cn/demo/images/007.png
Binary file added zh-cn/demo/images/008.png
Binary file added zh-cn/demo/images/009.png
Binary file added zh-cn/demo/images/010.png
Binary file added zh-cn/demo/images/011.png
Binary file added zh-cn/demo/images/012.png
Binary file added zh-cn/demo/images/013.png
Binary file added zh-cn/demo/images/014.png
Binary file added zh-cn/demo/images/015.png
Binary file added zh-cn/demo/images/016.png
Binary file added zh-cn/demo/images/018.png
Binary file added zh-cn/demo/images/019.png
Binary file added zh-cn/demo/images/020.png
Binary file added zh-cn/demo/images/021.png
Binary file added zh-cn/demo/images/022.png
Binary file added zh-cn/demo/images/023.png
Binary file added zh-cn/demo/images/024.png
Binary file added zh-cn/demo/images/025.png
Binary file added zh-cn/demo/images/026.png
6 changes: 6 additions & 0 deletions zh-cn/demo/images/openvela.svg
3 changes: 2 additions & 1 deletion FAQ_zh-cn.md → zh-cn/faq/FAQ_zh-cn.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# 常见问题汇总

\[ [English](./../../en/faq/FAQ.md) | 简体中文 \]

## 1. openvela 可以用什么语言开发应用
Native 主要是 C/C++,快应用使用 javascript。


## 2. Xiaomi Vela 和 openvela 的关系
openvela 和 Xiaomi vela 基于同一套代码实现,openvela 是开源版本。
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ADB 命令

\[ [English](./Android_Debug_Bridge_commands.md) | 简体中文 \]
\[ [English](./../../en/quickstart/Android_Debug_Bridge_commands.md) | 简体中文 \]

ADB 是一个功能丰富的命令行工具,用于与设备进行通信。`adb` 通过访问设备的 Unix shell 来在设备上运行各种命令。作为一种客户端-服务器程序,包括以下三个组件:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 编译 openvela 源码

\[ [English](Build_Vela_from_sources.md) | 简体中文 \]
\[ [English](./../../en/quickstart/Build_Vela_from_sources.md) | 简体中文 \]

## 使用 build.sh 构建 openvela

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 使用 openvela Emulator 调试

\[ [English](./Debugging_Vela_with_Vela_Emulator.md) | 简体中文 \]
\[ [English](./../../en/quickstart/Debugging_Vela_with_Vela_Emulator.md) | 简体中文 \]

## 使用 GDB Console

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 下载 openvela 源码

\[ [English](Download_Vela_sources.md) | 简体中文 \]
\[ [English](./../../en/quickstart/Download_Vela_sources.md) | 简体中文 \]

openvela 源码位于由 [GitHub](https://github.com/open-Vela)[Gitee](https://gitee.com/open-vela) 托管的 Git 仓库中。

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 在 openvela Emulator 上运行编译产物

\[ [English](./Run_Vela_on_Vela_Emulator.md) | 简体中文 \]
\[ [English](./../../en/quickstart/Run_Vela_on_Vela_Emulator.md) | 简体中文 \]

## openvela Emulator 概述

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 发送模拟器控制台命令

\[ [English](./Send_emulator_console_commands.md) | 简体中文 \]
\[ [English](./../../en/quickstart/Send_emulator_console_commands.md) | 简体中文 \]

每个正在运行的虚拟设备都提供了一个控制台,可用来查询和控制模拟设备的环境。

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 准备开发环境

\[ [English](Set_up_the_development_environment.md) | 简体中文 \]
\[ [English](./../../en/quickstart/Set_up_the_development_environment.md) | 简体中文 \]

## 硬件需求

Expand Down
Binary file added zh-cn/quickstart/images/001.png
Binary file added zh-cn/quickstart/images/002.png

0 comments on commit 49c0382

Please sign in to comment.