Skip to content

Fix typo and format in README #128

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix typo and format in README #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions README(ENGLISH).md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,13 @@ It covers various fields including basic data structures, graphics, acoustics, d
## 30-Second Quick Start Guide to PainterEngine

To incorporate PainterEngine into your project, all you need is:

```c
#include "PainterEngine.h"
```

Utilize `PainterEngine_Initialize` to swiftly create a graphical interactive interface:

```c
#include "PainterEngine.h"
int main()
Expand Down Expand Up @@ -46,8 +48,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,7 +66,7 @@ If you don't need the one-key compilation feature provided by PainterEngine Make

4. Add your code to the project.

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

| Functions | Support | Description |
| --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------------------ |
Expand All @@ -84,7 +84,7 @@ If you don't need the one-key compilation feature provided by PainterEngine Make
| Animation | 2dx/live2D | 2D frame-by-frame animation and a Live2D-style animation system |
| PainterScript | Compiler/VM/Debugger | A complete scripting engine, including a compiler, virtual machine, and debugger |
| UI | button/radio/image/edit/label/list/... | Implementation of common UI controls |
| protocals | MQTT/MODBUS/Game-network-synchronization | Common communication protocols |
| protocols | MQTT/MODBUS/Game-network-synchronization | Common communication protocols |
| 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|

Expand All @@ -102,7 +102,7 @@ A GPU IP core based on FPGA has been developed and functionally verified on the

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

## An abundance of components to unleash your creativity without limitations.
## An abundance of components to unleash your creativity without limitations

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

Expand All @@ -112,7 +112,7 @@ A GPU IP core based on FPGA has been developed and functionally verified on the

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

### Now, join the PainterEngine.com contribute to its development.
## Now, join the PainterEngine.com contribute to its development

<p align="center">
<img src="documents/assets/mini/1.png" alt="logo">
Expand Down
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,20 +46,19 @@ int main()

<p align="center">
<a href="https://cdn.painterengine.com/PainterEngine_make.zip" target="_blank" rel="noopener noreferrer">
<img src="images/pemake.png" alt="PainterEngine make">
<img src="images/pemake.png" alt="PainterEngine make">
</a>
</p>


## 快速开发, 无缝迁移

如果您不需要 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"), 并将对应文件夹中的所有代码添加到您的项目中.

3. 将 PainterEngine 所在目录, 添加到包含目录中.
3. 将 PainterEngine 所在目录, 添加到包含目录中.

4. 将您的代码添加进项目中.

Expand Down Expand Up @@ -109,7 +108,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 Expand Up @@ -146,4 +145,3 @@ int main()
<img src="documents/assets/mini/23.png" alt="logo">
<img src="documents/assets/mini/24.png" alt="logo">
</p>