Skip to content

optimize readme and doc again, and translate the doc to English #118

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

Open
R3c0ger wants to merge 13 commits into
base: master
Choose a base branch
from
Open

optimize readme and doc again, and translate the doc to English #118

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
3d5aff0
optimize readme and doc again
R3c0ger Nov 22, 2024
964c7c2
optimize readme and doc again
R3c0ger Nov 22, 2024
c56138d
Merge branch 'master' of https://github.com/R3c0ger/PainterEngine
R3c0ger Nov 22, 2024
a4af119
optimize code style in md code block and ulist
R3c0ger Nov 23, 2024
82f4ef1
Merge branch 'master' of https://github.com/matrixcascade/PainterEngine
R3c0ger Nov 23, 2024
ab2238d
fix readme
R3c0ger Nov 23, 2024
c94de78
traslate the doc to english 1-6
R3c0ger Nov 23, 2024
cd7c265
traslate the doc to english 7-12
R3c0ger Nov 23, 2024
80b391f
traslate the doc to english 13-17
R3c0ger Nov 23, 2024
f759838
finish translation
R3c0ger Nov 23, 2024
9c90ef9
Merge branch 'master' of https://github.com/matrixcascade/PainterEngine
R3c0ger Nov 23, 2024
159934a
Merge
R3c0ger Nov 23, 2024
8b07c86
Merge branch 'master' of https://github.com/matrixcascade/PainterEngine
R3c0ger Nov 23, 2024
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
53 changes: 30 additions & 23 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,19 @@
</a>
</p>

[![ENGLISH](https://img.shields.io/badge/language-English-red.svg)](https://github.com/QuantumCipherMaster/PainterEngine/blob/master/README(ENGLISH).md)
[![ENGLISH](https://img.shields.io/badge/language-English-red.svg)](README_en.md)

PainterEngine 是一个由 C 语言编写的跨平台图形引擎, 支持 Windows/Linux/iOS/Android/WebAssembly 甚至无操作系统的裸嵌入式平台, 它基于组件化的设计模式, 即使是 C 语言初学者, 也可以在几分钟内掌握它的使用, [PainterEngine Make](https://www.painterengine.com/) 允许您一键将您的 PainterEngine 项目编译到多个平台.
它涵盖了基础数据结构、图形学、声学、数字信号处理、编译原理、虚拟机系统、密码学、人机交互、游戏引擎、FPGA-GPU 图形 IP 设计等多个领域, 你既可以用它制作微应用, 也可以将它作为学习项目。
PainterEngine 是一个由 C 语言编写的跨平台图形引擎，支持 Windows/Linux/iOS/Android/WebAssembly 甚至无操作系统的裸嵌入式平台，它基于组件化的设计模式，即使是 C 语言初学者，也可以在几分钟内掌握它的使用，[PainterEngine Make](https://www.painterengine.com/) 允许您一键将您的 PainterEngine 项目编译到多个平台。
它涵盖了基础数据结构、图形学、声学、数字信号处理、编译原理、虚拟机系统、密码学、人机交互、游戏引擎、FPGA-GPU 图形 IP 设计等多个领域，你既可以用它制作微应用，也可以将它作为学习项目。

现在了解并使用 PainterEngine $\longrightarrow$
*__[PainterEngine 快速入门手册（中文版）](./documents/PainterEngine_the_book_zh-CN.md)__*

## 30 秒速览 PainterEngine

将 PainterEngine 引入到您的 C/C++ 项目中, 仅仅需要 `#include "PainterEngine.h"`.
将 PainterEngine 引入到您的 C/C++ 项目中，仅仅需要 `#include "PainterEngine.h"`。

使用 `PainterEngine_Initialize`, 快速创建一个图形化的交互式界面:
使用 `PainterEngine_Initialize`，快速创建一个图形化的交互式界面：

```c
#include "PainterEngine.h"
Expand All @@ -24,7 +27,7 @@ int main()
}
```

创建组件, 或者...创造自己的组件:
创建组件，或者……创造自己的组件：

```c
#include "PainterEngine.h"
Expand All @@ -42,7 +45,7 @@ int main()
<img src="images/firework.png" alt="PainterEngine firework">
</p>

使用 [PainterEngine Make](https://www.painterengine.com/) 快速将您的项目编译到 Windows, Linux, WebAssembly, Android 等任意平台, 一键编译部署, 源码无需修改, 零成本移植.
使用 [PainterEngine Make](https://www.painterengine.com/) 快速将您的项目编译到 Windows、Linux、WebAssembly、Android 等任意平台，一键编译部署，源码无需修改，零成本移植。

<p align="center">
<a href="https://cdn.painterengine.com/PainterEngine_make.zip" target="_blank" rel="noopener noreferrer">
Expand All @@ -51,55 +54,59 @@ int main()
</p>


## 快速开发, 无缝迁移
## 快速开发，无缝迁移

如果您不需要 PainterEngine Make 提供的一键编译功能，希望使用自己常用的 IDE 开发 PainterEngine 程序或组件，您只需要：

如果您不需要 PainterEngine Make 提供的一键编译功能, 希望使用自己常用的 IDE 开发 PainterEngine 程序或组件, 您只需要:
1. 将 "PainterEngine/core"、"PainterEngine/kernel"、"PainterEngine/runtime" 的所有代码，添加到您的项目中。

1. 将 "PainterEngine/core", "PainterEngine/kernel", "PainterEngine/runtime" 的所有代码, 添加到您的项目中.
2. 在 "PainterEngine/platform" 中选择您的工作平台（例如 Windows 中选择 "PainterEngine/platform/windows"），并将对应文件夹中的所有代码添加到您的项目中。

2. 在 "PainterEngine/platform" 中选择您的工作平台(例如 Windows 中选择 "PainterEngine/platform/windows"), 并将对应文件夹中的所有代码添加到您的项目中.
3. 将 PainterEngine 所在目录添加到包含目录中。

3. 将 PainterEngine 所在目录, 添加到包含目录中.
4. 将您的代码添加进项目中。

4. 将您的代码添加进项目中.
即可使用您的 IDE 完成 PainterEngine 的编译，PainterEngine 库将尽力保证所有平台的的运行结果一致性，在 Windows 上开发，同样在 Android/web/Linux/iOS/…… 中能够得到一致的结果。

## 不仅是图形库, 更是应用程序框架

| 功能 | 支持内容 | 描述 |
| --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------ |
| 内存池 | alloc/free | 平台无关的内存池实现 |
| 数学库 | sin/cos/tan/arcsin/log/exp/relu/... | 绝大部分 C 标准数学库的完整实现 |
| 信号处理 | dft/dct/fft/dwt/window functions/mfcc/... | 傅里叶/余弦/小波变换, 常用窗函数, mfcc 等特征采集算法...等等信号处理相关基础函数及上层特征采集算法 |
| 信号处理 | dft/dct/fft/dwt/window functions/mfcc/... | 傅里叶/余弦/小波变换、常用窗函数、mfcc 等特征采集算法……等等信号处理相关基础函数及上层特征采集算法 |
| 数据结构 | string/vector/list/map/stack/fifo/circular-buffer/... | 平台无关的数据结构算法实现 |
| 密码学 | curve25519/AES/SHAx/MD5/... | 包含常用的密钥对称算法及密钥协商算法 |
| 图片支持 | PNG/JPG/GIF/BMP | 支持 PNG/JPG/GIF/BMP 解码及 PNG 编码 |
| 音频支持 | WAV/MP3 | 支持 Wav, Mp3 解码及 Wav 编码|
| 字模支持 | ttf | 支持 ttf 字模文件(由 stb_truetype.c 移植而来)|
| 音频支持 | WAV/MP3 | 支持 Wav、Mp3 解码及 Wav 编码|
| 字模支持 | ttf | 支持 ttf 字模文件（由 stb_truetype.c 移植而来）|
| 几何绘制 | Line/Triangle/Rectangle/Circle/Ring/Sector/Rounded/... | 常用几何光栅化实现 |
| 渲染器 | 2D/3D | 2D/3D 渲染器实现及一个高质量制图引擎 |
| 动画 | 2dx/live2D | 2D 动画和一个类 Live2D 骨骼动画系统 |
| 声学模型 | mixer/piano/ks | 包含一个混音器实现, 一个相位声码器, 一个物理建模的钢琴及 karplus-strong 合成的拨弦模型, 直接合成 PCM 音频流 |
| 脚本引擎 | Compiler/VM/Debugger | 一个完整的脚本引擎, 包含编译器虚拟机调试器 |
| 声学模型 | mixer/piano/ks | 包含一个混音器实现、一个相位声码器、一个物理建模的钢琴及 karplus-strong 合成的拨弦模型，直接合成 PCM 音频流 |
| 脚本引擎 | Compiler/VM/Debugger | 一个完整的脚本引擎，包含编译器虚拟机调试器 |
| UI 框架 | button/radio/image/edit/label/list/... | UI 框架实现 |
| 协议 | MQTT/MODBUS/Game-network-synchronization | 常用的通讯协议 |
| 游戏引擎 | | 集成一个游戏世界框架 |
| FPGA-GPU |2D accelerator | 实现了基于 FPGA 的 GPU 图形加速器, 能够为 PainterEngine 提供不低于 50Mpps 的 2D Blender 及图元光栅化加速, 支持 HDMI 输出, 目前已在 zynq7000 系列 Soc 上完成验证|
| FPGA-GPU |2D accelerator | 实现了基于 FPGA 的 GPU 图形加速器，能够为 PainterEngine 提供不低于 50Mpps 的 2D Blender 及图元光栅化加速，支持 HDMI 输出，目前已在 zynq7000 系列 Soc 上完成验证|

还有更多探索……

## FPGA-GPU 嵌入式图形加速方案

提供一个基于 FPGA 的 GPU IP 核, 已在 Zynq7020 上完成功能验证, 提供不低于 50Mpps 的 2D Blender 图形渲染加速, 支持 HDMI 输出, 目前已在 zynq7000 系列 Soc 上完成验证.
提供一个基于 FPGA 的 GPU IP 核，已在 Zynq7020 上完成功能验证，提供不低于 50Mpps 的 2D Blender 图形渲染加速，支持 HDMI 输出，目前已在 zynq7000 系列 SoC 上完成验证。

<p align="center"><img src="images/gpu_block_design.png" alt="PainterEngine designer"></p>

<p align="center"><img src="images/gpu_demo.png" alt="PainterEngine designer"></p>

<p align="center"><img src="images/gpu_demo2.png" alt="PainterEngine designer"></p>

## 组件化开发, 支持设计器模式, 简单的不能再简单
## 组件化开发，支持设计器模式，简单的不能再简单

<p align="center"><img src="images/designer.png" alt="PainterEngine designer"></p>

## 海量组件, 创意无界
## 海量组件，创意无界

<p align="center"><img width="600" src="images/market.png" alt="PainterEngine market"></p>

Expand All @@ -109,7 +116,7 @@ int main()

<p align="center"><img width="600" src="images/l2d.png" alt="PainterEngine market"></p>

### 现在, 访问 PainterEngine.com, 参与建设
### 现在，访问 PainterEngine.com，参与建设

<p align="center">
<img src="documents/assets/mini/1.png" alt="logo">
Expand Down
17 changes: 11 additions & 6 deletions README(ENGLISH).md → README_en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@
</a>
</p>

[![中文](https://img.shields.io/badge/语言-中文-brightgreen)](https://github.com/QuantumCipherMaster/PainterEngine/blob/master/README.md)
[![中文](https://img.shields.io/badge/语言-中文-brightgreen)](README.md)

PainterEngine is a cross-platform graphics engine written in C language, with support for Windows, Linux, iOS, Android, WebAssembly, and even bare-metal embedded platforms without OS. It is built on a component-based design pattern, making it accessible to even C language beginners. [PainterEngine Make](https://www.painterengine.com/) enables you to compile your PainterEngine project for multiple platforms with just one click.
It covers various fields including basic data structures, graphics, acoustics, digital signal processing, compiler design, virtual machine systems, cryptography, human-computer interaction, game engines, FPGA-GPU graphics acceleration, and more. You can use it to create mini-applications or as a learning project for acquiring knowledge.

Now, learn and use PainterEngine $\longrightarrow$
*__[PainterEngine Quick Start Guide (English Version)](./documents/PainterEngine_the_book_en.md)__*

## 30-Second Quick Start Guide to PainterEngine

To incorporate PainterEngine into your project, all you need is:
Expand All @@ -33,9 +36,9 @@ Create components or even craft your own:
int main()
{
PainterEngine_Initialize(800, 600);
PX_Object_Firework01Create(mp, root,200,600);
PX_Object_Firework01Create(mp, root,400,600);
PX_Object_Firework01Create(mp, root,600,600);
PX_Object_Firework01Create(mp, root, 200, 600);
PX_Object_Firework01Create(mp, root, 400, 600);
PX_Object_Firework01Create(mp, root, 600, 600);
return 1;
}
```
Expand All @@ -46,8 +49,6 @@ int main()

Use ["PainterEngine Make"](https://www.painterengine.com/) to quickly compile and deploy your project to various platforms such as Windows, Linux, WebAssembly, Android, and more. One-click compilation and deployment, with no need to modify the source code, enabling seamless portability at zero cost.



<p align="center">
<a href="https://cdn.painterengine.com/PainterEngine_make_en.zip" target="_blank" rel="noopener noreferrer">
<img src="images/pemakeen.png" alt="PainterEngine make">
Expand All @@ -66,6 +67,8 @@ If you don't need the one-key compilation feature provided by PainterEngine Make

4. Add your code to the project.

You can now use your IDE to compile PainterEngine with these steps. PainterEngine library will strive to ensure consistent results across all platforms. What you develop on Windows will yield consistent results on Android, web, Linux, iOS, and more.

## Not just a graphics library but also an application framework.

| Functions | Support | Description |
Expand All @@ -88,6 +91,8 @@ If you don't need the one-key compilation feature provided by PainterEngine Make
| Game framework | | PainterEngine Game Framework |
| FPGA-GPU | 2D accelerator | Implemented an FPGA-based GPU graphics accelerator that provides at least 50 million pixels per second (Mpps) 2D Blender acceleration for PainterEngine and supports HDMI output. Validation has been completed on the Zynq-7000 series SoC|

Many more to explore...

## The FPGA-GPU Graphics Acceleration Solution

A GPU IP core based on FPGA has been developed and functionally verified on the Zynq 7020 platform. It provides 2D Blender graphics rendering acceleration with a performance of no less than 50Mpps (Million pixels per second) and supports HDMI output. This solution has been successfully validated on the Zynq 7000 series SoC.
Expand Down
Loading