修改 readme 新版本简化描述和使用

2024-11-29 18:28:06 +08:00 · 2023-09-15 21:47:40 +08:00 · 2023-09-15 21:47:40 +08:00 · 4ba4add385
commit 4ba4add385
parent ddd93ba521
2 changed files with 38 additions and 45 deletions
--- a/README.md
+++ b/README.md
@ -4,7 +4,7 @@

 <p align="center" style="font-size: 24px;">
    <strong>
-        Energy is framework for Go to build desktop applications based on CEF
+        Energy is a framework for Go to build desktop applications based on CEF
    </strong>
 </p>

@ -22,31 +22,24 @@ English

 ### [Project Introduction](https://energy.yanghy.cn/course/100/6350f94ca749ba0318943f25)

-Energy is a framework developed by Golang based on CEF(Chromium Embedded Framework), embedded
-with [CEF](https://bitbucket.org/chromiumembedded/cef) binary
+Energy is a framework by Golang based on CEF(Chromium Embedded Framework), embedded
+[CEF](https://bitbucket.org/chromiumembedded/cef) binary
 > [energy](https://github.com/energye/energy) is a framework developed by Golang based on CEF(Chromium Embedded
 > Framework), embedded with [CEF](https://bitbucket.org/chromiumembedded/cef) binary
 >
 > Use Go and Web technology (HTML+CSS+JavaScript) to build cross-platform desktop applications that support Windows,
 > Linux and MacOS
->
-> Knowledge of the front-end technology stack and some knowledge of the Go language is required
-
 ### Characteristic

 > - Rich CEF API and LCL system native widgets
-> - development environment is simple and the compilation speed is fast. Only the Go development environment and the CEF
-    binary framework that Energy depends on are needed
-> - cross-platform: A set of code can be packaged into Windows, domestic UOS, Deepin, Kylin, MacOS, Linux
-> - Language responsibilities
->> - Go: Go is responsible for window creation, CEF configuration and function implementation, creation of various UI
-     components, low-level system calls, and functions that JS cannot handle, such as file stream, security encryption,
-     high-performance processing, etc.
->> - Web: HTML + CSS + JavaScript responsible for the function of the client interface, make any interface you want, Any front-end technology framework can be used
-> - front-end technology: Support mainstream front-end frameworks, such as Vue, React, Angular or pure HTML+CSS
-> - event driven: High performance event driven, IPC based communication, Go and Web side is very convenient function
-    call and data interaction
-> - resource loading: supports local or built-in to executable files, http service support is not required, multiple choices.
+> - Development environment is simple and the compilation speed is fast. Only need Go and Energy.
+> - Cross-Platform: You can package your code as Windows, domestic UOS, Deepin, Kylin, MacOS and Linux
+> - Responsibilities
+>> - Go: Go is responsible for creating Windows, configuring CEF and implementing functions, creating various UI components, calling the low level of the system and some functions that JS cannot handle, such as: file flow, security encryption, high-performance processing, etc.
+>> - Web: HTML + CSS + JavaScript is responsible for the function of the client interface, you can make any interface you want.
+> - Front-end technology: Support mainstream frameworks, such as Vue, React, Angular or pure HTML+CSS+JS.
+> - Event driven: High performance event driven, based on IPC communication, Go and Web can call each other quality.
+> - Esource loading: You can either read local resources or resources build into execution files without http services, or you can load resources using http services.

 ### Built-in dependency&integration

@ -64,9 +57,9 @@ with [CEF](https://bitbucket.org/chromiumembedded/cef) binary

 - Automatic installation development environment

-> Automatically install the complete development environment using the energy command-line tool [Download address](https://energy.yanghy.cn/course/100/1694511322285207)
+> Using the energy command-line tool [Download address](https://energy.yanghy.cn/course/100/1694511322285207)
 >
-> This installation process selectively downloads the following frameworks and tools from the network
+> During the installation process, you can optionally install the following frameworks and tools, or you can download the resources yourself.

 | Name        | Platform       | illustrate                                   |
 |-------------|----------------|----------------------------------------------|
@ -76,21 +69,21 @@ with [CEF](https://bitbucket.org/chromiumembedded/cef) binary
 | UPX         | Windows, Linux | Execute file compression tool                |
 | 7z          | Windows, Linux | CEF Framework compression tool               |

-### Getting Started Guide - [Transfer gate](https://energy.yanghy.cn)
+### Guide to Start - [Link](https://energy.yanghy.cn)

 * [Course](https://energy.yanghy.cn/course/100/0)
 * [Example](https://energy.yanghy.cn/example/200/0)
 * [Document](https://energy.yanghy.cn/document/300/0)

-### Quick Get Start
+### Quick Start

-> Using [energy](https://energy.yanghy.cn/course/100/1694511322285207) Command line tools automatically install the complete development environment
+> Using [energy](https://energy.yanghy.cn/course/100/1694511322285207) Command line tools to install the complete development environment automatically.

-### Run a simple application in three steps
+### Run a simple application by three steps

-1. Installation and development environment: `energy install .`
-2. Initiate Application: `energy init .`
-3. Run Application: `go run main.go`
+1. Install development environment: `energy install .`
+2. Initiate an Application: `energy init .`
+3. Run the Application: `go run main.go`

 ### sample code

@ -115,10 +108,10 @@ func main() {
 }
 ```

-### Pack Project
-1. build：`energy build .`
-2. package：`energy package .`
-3. The final automatically generated installation package
+### Build
+1. Build：`energy build .`
+2. Package：`energy package .`
+3. Package Type：
    - windows  Using`nsis`Create exe installation package
    - linux    Using`dpkg`Create deb installation package
    - macos    Generate`xxx.app`
@ -148,7 +141,8 @@ func main() {
    </a>
 </p>

-Thank you for ordering a Star for the project
+If this project is helpful to you, please give me a star
+

 ---

--- a/README.zh_CN.md
+++ b/README.zh_CN.md
@ -27,20 +27,19 @@
 > 开发的框架，内嵌 [CEF](https://bitbucket.org/chromiumembedded/cef) 二进制
 >
 > 使用 Go 和 Web 端技术 ( HTML + CSS + JavaScript ) 构建支持Windows, Linux, MacOS跨平台桌面应用
-> 
-> 需要会前端技术栈和略懂Go语言
+

 ### 特性

 > - 具有丰富的CEF API 和 LCL 系统原生小部件
-> - 开发环境简单,编译速度快,只需要Go和Energy依赖的CEF二进制框架
+> - 开发环境简单,编译速度快,仅需Go和Energy依赖的CEF二进制框架
 > - 跨平台: 一套代码可以打包成 Windows, 国产UOS、Deepin、Kylin, MacOS, Linux
-> - 语言职责
->> - Go: Go负责窗口创建、CEF配置和功能实现、各种UI组件创建、系统低层调用，和JS处理不了的功能如: 文件流、安全加密、高性能处理等等
+> - 职责
+>> - Go: Go负责窗口创建、CEF配置和功能实现、各种UI组件创建、系统低层调用和JS处理不了的功能，如: 文件流、安全加密、高性能处理等
 >> - Web: HTML + CSS + JavaScript 负责客户端界面的功能, 做出任意你想要的界面
-> - 前端技术: 支持主流前端框架例如：Vue、React、Angular, 或纯HTML+CSS等等
-> - 事件驱动: 高性能事件驱动, 基于IPC通信，实现Go和Web端很方便功能调用以及数据交互
-> - 资源加载: 支持本地或内置到执行文件, 不需要http服务支撑, 多种选择
+> - 前端技术: 支持主流前端框架。例如：Vue、React、Angular 和 原生HTML+CSS+JS等
+> - 事件驱动: 高性能事件驱动, 基于IPC通信，实现Go和Web端迅捷调用及数据交互
+> - 资源加载: 可无需http服务支撑，直接读取本地资源或内置到执行文件的资源, 也支持http服务加载资源

 ### 内置依赖&集成

@ -58,9 +57,9 @@

 - 自动安装开发环境

-> 使用 energy 命令行工具自动安装完整开发环境 [下载地址](https://energy.yanghy.cn/course/100/1694511322285207)
+> 使用 energy 命令行工具自动安装完整开发环境 [命令行工具下载地址](https://energy.yanghy.cn/course/100/1694511322285207)
 > 
-> 此安装过程有选择性的从网络下载以下框架和工具
+> 此安装过程可选择性安装以下框架和工具，也可自行下载资源

 | 名称          | 平台             | 说明             |
 |-------------|----------------|----------------|
@ -109,10 +108,10 @@ func main() {
 }
 ```

-### 项目打包
+### 应用打包
 1. 编译：`energy build .`
 2. 打包：`energy package .`
-3. 最后自动生的安装包
+3. 自动生成的安装包
   - windows  使用`nsis`工具生成exe安装包
   - linux    使用`dpkg`制作deb安装包
   - macos    生成`xxx.app`
@ -143,7 +142,7 @@ func main() {
 </p>


-感谢您给项目点个Star
+如果你觉得此项目对你有帮助，请点亮 Star

 ---