Skip to content

Commit

Permalink
update packages_apps readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ismewumei committed Dec 25, 2024
1 parent a97e7b9 commit fee535a
Show file tree
Hide file tree
Showing 5 changed files with 90 additions and 45 deletions.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<h1 align="center"> Xiaomi Vela JS Application</h1>

## Introduction

Xiaomi Vela JS application is a type of application developed by Xiaomi, which is based on Xiaomi's Internet of Things embedded software platform Xiaomi Vela OS.

## Technical Advantages

- **Lightweight**: Xiaomi Vela JS Application adopt a lightweight architecture design, making them capable of quick loading and running, especially suitable for wearable devices with limited memory and processing capabilities.

- **Cross-platform compatibility**: Xiaomi Vela JS Application support cross-platform operation, allowing developers to develop once and run on multiple devices, significantly improving development efficiency and application popularity.

- **High-performance rendering**: The system optimizes rendering capabilities, making the animations and interactions smoother, enhancing user experience.

- **Security**: Xiaomi Vela OS ensures application security through a three-layered isolation mechanism, protecting user data and device security.

- **Development Support**: Xiaomi provides comprehensive support for developing Xiaomi Vela JS Application, including a range of development tools and a well-documented environment for developers to easily get started and build high-quality applications. Xiaomi provides a range of development tools, including AIoT-IDE, which supports development on Ubuntu, Windows, MacOS, and more.

## Development Tools
AIoT-IDE is an official integrated development environment for developing Xiaomi Vela JS application, based on Visual Studio Code (referred to as VS Code), inheriting all the features of VS Code, such as code editing, plugin integration, theme customization, and personalized settings. In addition, AIoT-IDE introduces a range of enhanced features specifically for Xiaomi Vela JS application, including:
- Intelligent coding prompts
- Xiaomi Vela JS Application debugging
- Real-time compilation preview
- Xiaomi Vela JS Application packaging and publishing
For more details, please refer to [Developing JS applications using the IDE](https://iot.mi.com/vela/quickapp/zh/guide/start/use-ide.html).

## Code Structure

```cpp
├── common # Common application examples
├── smartspeaker # Speaker application examples
├── wearable # Wearable device application examples
```

## Getting Started

If you want to experience Xiaomi Vela JS Application, we provide a fully-featured simulator, no hardware platform required. For more information, please refer to the following guides.

1. [Prepare the development environment](https://iot.mi.com/vela/quickapp/zh/guide/start/use-ide.html)
2. Clone the repository to your local machine
```bash
git clone https://github.com/open-vela/packages_apps.git
```
3. Compile and Run
Open the application project in the example, open the project in Aiot-IDE, and click the run button to compile and run.
45 changes: 45 additions & 0 deletions README_zh-cn.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<h1 align="center">Xiaomi Vela JS 应用</h1>

## 简介

Xiaomi Vela JS 应用是小米公司开发的一种应用类型,它是基于小米的物联网嵌入式软件平台 Xiaomi Vela OS 开发的。

## 技术优势

- **轻量化**:Xiaomi Vela JS 应用采用了轻量级的架构设计,与传统的应用程序相比,Xiaomi Vela JS 应用具有更小的体积,这使得它们能够快速加载和运行,尤其适合内存和处理能力有限的穿戴设备。

- **跨平台兼容性**:Xiaomi Vela JS 应用支持跨端运行,开发者可以一次开发,实现在多种设备上的运行,这大大提高了开发效率和应用的普及率。

- **高性能渲染**:系统优化了渲染能力,使得应用的动画和交互更为流畅,提升了用户的使用体验。

- **安全性能**:Xiaomi Vela OS 通过三重隔离机制确保了应用的安全性,保护了用户数据和设备的安全。

- **开发支持**:小米提供了全面的开发支持Xiaomi Vela JS 应用的开发工具和文档齐全,开发者可以轻松上手,快速构建高质量的应用。小米提供了包括AIoT-IDE在内的一系列开发工具,支持开发者在Ubuntu、Windows、MacOS等操作系统上进行Xiaomi Vela JS 应用的开发和调试。

## 开发工具
AIoT-IDE 是用于开发Xiaomi Vela JS 应用的官方集成开发环境,建立在 Visual Studio Code(以下简称 VS Code)的基础上,继承了 VS Code 的全部功能,比如代码编辑、插件集成、主题定制及个性化设置。此外,AIoT-IDE 还引入了一系列专门针对 Xiaomi Vela JS 应用 开发的增强功能,主要包括如下功能:
- 智能编码提示
- Xiaomi Vela JS 应用调试
- 实时编译预览
- Xiaomi Vela JS 应用打包发布
更多详情请参见[使用IDE来开发JS应用](https://iot.mi.com/vela/quickapp/zh/guide/start/use-ide.html)

## 代码结构

```cpp
├── common # 通用应用示例集
├── smartspeaker # 音箱应用示例集
├── wearable # 可穿戴设备应用示例集
```

## 快速入门

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

1. [准备开发环境](https://iot.mi.com/vela/quickapp/zh/guide/start/use-ide.html)
2. 克隆本仓库到本地
```bash
git clone https://github.com/open-vela/packages_apps.git
```
3. 编译运行
打开示例中的应用项目,在AIoT-IDE中打开此项目,点击运行按钮即可编译运行。
30 changes: 0 additions & 30 deletions common/README.md

This file was deleted.

2 changes: 0 additions & 2 deletions smartspeaker/README.md

This file was deleted.

13 changes: 0 additions & 13 deletions wearable/README.md

This file was deleted.

0 comments on commit fee535a

Please sign in to comment.