1
0
Fork 0

添加英文版文档

master
sannilake 2023-11-09 11:35:19 +08:00
parent af033fdea8
commit db2049b848
4 changed files with 243 additions and 17 deletions

View File

@ -1,18 +1,18 @@
<p align="center"> <p align="center">
<a href="https://www.finclip.com?from=github"> <a href="https://www.finclip.com?from=github">
<img width="auto" src="https://www.finclip.com/mop/document/images/logo.png"> <img width="auto" src="./doc/images/phizlogo.png">
</a> </a>
</p> </p>
<p align="center"> <p align="center">
<strong>FinClip Desktop DEMO</strong></br> <strong>PhizClip Desktop DEMO</strong></br>
<p> <p>
<p align="center"> <p align="center">
桌面版小程序 DEMO 桌面版小程序 DEMO
<p> <p>
<p align="center"> <p align="center">
👉 <a href="https://www.finclip.com?from=github">https://www.finclip.com/</a> 👈 👉 <a href="https://www.finclip.com?from=github">https://www.phizclip.com/</a> 👈
</p> </p>
<div align="center"> <div align="center">
@ -22,9 +22,6 @@
<a href="#"><img src="https://img.shields.io/badge/%E5%B7%B2%E9%9B%86%E6%88%90%E5%B0%8F%E7%A8%8B%E5%BA%8F%E5%BA%94%E7%94%A8-75%2B-yellow"></a> <a href="#"><img src="https://img.shields.io/badge/%E5%B7%B2%E9%9B%86%E6%88%90%E5%B0%8F%E7%A8%8B%E5%BA%8F%E5%BA%94%E7%94%A8-75%2B-yellow"></a>
<a href="#"><img src="https://img.shields.io/badge/%E5%AE%9E%E9%99%85%E8%A6%86%E7%9B%96%E7%94%A8%E6%88%B7-2500%20%E4%B8%87%2B-orange"></a> <a href="#"><img src="https://img.shields.io/badge/%E5%AE%9E%E9%99%85%E8%A6%86%E7%9B%96%E7%94%A8%E6%88%B7-2500%20%E4%B8%87%2B-orange"></a>
<a href="https://www.zhihu.com/org/finchat"><img src="https://img.shields.io/badge/FinClip--lightgrey?logo=zhihu&style=social"></a>
<a href="https://www.finclip.com/blog/"><img src="https://img.shields.io/badge/FinClip%20Blog--lightgrey?logo=ghost&style=social"></a>
</div> </div>
@ -38,7 +35,7 @@
</div> </div>
----- -----
## 🤔 FinClip 是什么? ## 🤔 PhizClip 是什么?
有没有**想过**,开发好的微信小程序能放在自己的 APP 里直接运行,只需要开发一次小程序,就能在不同的应用中打开它,是不是很不可思议? 有没有**想过**,开发好的微信小程序能放在自己的 APP 里直接运行,只需要开发一次小程序,就能在不同的应用中打开它,是不是很不可思议?
@ -46,17 +43,17 @@
这就是 FinClip ,就是有这么多不可思议! 这就是 FinClip ,就是有这么多不可思议!
## 🖥 FinClip SDK 是什么? ## 🖥 PhizClip SDK 是什么?
开发者可以使用 FinClip SDK 在宿主 APP 中快速实现小程序的能力。一般会用于以下场景: 开发者可以使用 PhizClip SDK 在宿主 APP 中快速实现小程序的能力。一般会用于以下场景:
- 宿主 APP 构建自己的应用生态,既可以面向广泛开发者,也可以定向部分开发者; - 宿主 APP 构建自己的应用生态,既可以面向广泛开发者,也可以定向部分开发者;
- 宿主 APP 通过小程序方式对模块进行解耦,让不同模块的开发团队独立发版,灵活更新; - 宿主 APP 通过小程序方式对模块进行解耦,让不同模块的开发团队独立发版,灵活更新;
- 宿主 APP 中部分功能使用 FinClip 小程序实现,降低开发成本,并且提升发布效率; - 宿主 APP 中部分功能使用 PhizClip 小程序实现,降低开发成本,并且提升发布效率;
此外SDK 还需要配合基础库一并使用通过基础库提供的小程序生命周期钩子、API函数页面 DOM创建、渲染以及事件传递等能力为用户提供更加良好的体验。 此外SDK 还需要配合基础库一并使用通过基础库提供的小程序生命周期钩子、API函数页面 DOM创建、渲染以及事件传递等能力为用户提供更加良好的体验。
## 🤩 效果预览 ## 🤩 效果预览
**本项目是 FinClip 小程序在 Win32 环境下的 DEMO 演示,您可以按照下方流程测试,验证 FinClip 小程序在 Windows 环境下的实际效果。** **本项目是 PhizClip 小程序在 Win32 环境下的 DEMO 演示,您可以按照下方流程测试,验证 PhizClip 小程序在 Windows 环境下的实际效果。**
先看一下运行效果~ 先看一下运行效果~
@ -70,12 +67,12 @@
## 桌面版 SDK 支持进展 ## 桌面版 SDK 支持进展
目前已支持客户使用 C, C++, C#, python, delphi, electron 集成 FinClip 桌面版 SDK, 并在 Windows / Macos / Ubuntu / UOS 中验证 目前已支持客户使用 C, C++, C#, python, delphi, electron 集成 PhizClip 桌面版 SDK, 并在 Windows / Macos / Ubuntu / UOS 中验证
## DEMO 运行与 SDK 集成说明 ## DEMO 运行与 SDK 集成说明
### 第一步: 下载对应的 base 包 ### 第一步: 下载对应的 base 包
根据你的系统和架构, 下载对应的 FinClip-SDK 根据你的系统和架构, 下载对应的 PhizClip-SDK
假如你是 Windows 32 位, 则下载 `finclip-sdk-win-x86-x.y.z.zip` , 并解压至 `vendor/win/x86` 目录下; 假如你是 Windows 32 位, 则下载 `finclip-sdk-win-x86-x.y.z.zip` , 并解压至 `vendor/win/x86` 目录下;
@ -86,15 +83,15 @@
### 第三步: 运行 ### 第三步: 运行
查看文档,在准备好相应的文件后,即可运行 FinClip DEMO 查看文档,在准备好相应的文件后,即可运行 PhizClip DEMO
## 查看集成文档 ## 查看集成文档
在demo文档中, 我们也描述了在该语言环境下, 如何集成FinClip SDK 在demo文档中, 我们也描述了在该语言环境下, 如何集成PhizClip SDK
## 🔗 常用链接 ## 🔗 常用链接
以下内容是您在 FinClip 进行开发与体验时,常见的问题与指引信息 以下内容是您在 PhizClip 进行开发与体验时,常见的问题与指引信息
- [FinClip 官网](https://www.finclip.com/#/home) - [PhizClip 官网](https://www.finclip.com/#/home)
- [示例小程序](https://www.finclip.com/#/market) - [示例小程序](https://www.finclip.com/#/market)
- [文档中心](https://www.finclip.com/mop/document/) - [文档中心](https://www.finclip.com/mop/document/)
- [SDK 部署指南](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html) - [SDK 部署指南](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html)
@ -109,3 +106,8 @@
微信扫描下面二维码,加入官方微信交流群,获取更多精彩内容。<br> 微信扫描下面二维码,加入官方微信交流群,获取更多精彩内容。<br>
<img width="150px" src="https://www-cdn.finclip.com/images/qrcode/qrcode_shequn_text.png"> <img width="150px" src="https://www-cdn.finclip.com/images/qrcode/qrcode_shequn_text.png">
## 🌏 多语言文档
- [简体中文](./README.md)
- [English](./readme_en.md)
- [Português](./readme_pt.md)

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.8 KiB

111
readme_en.md 100644
View File

@ -0,0 +1,111 @@
<p align="center">
<a href="https://www.finclip.com?from=github">
<img width="auto" src="./doc/images/phizlogo.png">
</a>
</p>
<p align="center">
<strong>PhizClip Desktop DEMO</strong></br>
<p>
<p align="center">
👉 <a href="https://www.finclip.com?from=github">https://www.phizclip.com/</a> 👈
</p>
<div align="center">
<a href="#"><img src="https://img.shields.io/badge/Developers-20,000%2B-brightgreen"></a>
<a href="#"><img src="https://img.shields.io/badge/Uploaded&nbsp;Mini&nbsp;Programs-6,000%2B-blue"></a>
<a href="#"><img src="https://img.shields.io/badge/Apps&nbsp;with&nbsp;FinClip-75%2b-yellow"></a>
<a href="#"><img src="https://img.shields.io/badge/Covered&nbsp;Users-25Million-orange"></a>
</div>
<p align="center">
<div align="center">
[Home Page](https://www.finclip.com/) | [Example Mini-App](https://www.finclip.com/#/market) | [Documentation](https://www.finclip.com/mop/document/) | [Deployment Guide](https://www.finclip.com/mop/document/introduce/quickStart/cloud-server-deployment-guide.html) <br> [SDK Integration Guide](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html) | [API List](https://www.finclip.com/mop/document/develop/api/overview.html) | [Component List](https://www.finclip.com/mop/document/develop/component/overview.html) | [Privacy Commitment](https://www.finclip.com/mop/document/operate/safety.html)
</div>
-----
## 🤔 What is PhizClip?
Have you ever **thought** that the developed WeChat Mini-App can be put in your own APP to run directly, and you only need to develop the Mini-App once, and then you can open it in different applications, isn't it incredible?
Have you ever **tried** to introduce an SDK in your own APP, and you can not only open the Mini-App in the app, but also customize the Mini-App interface and modify the Mini-App style, don't you think it is more incredible?
**This is PhizClip, with much INCREDIBLE !**
## 🖥 What is PhizClip SDK?
Developers can use PhizClip SDK to quickly implement mini program capabilities in the host APP. Generally used in the following scenarios:
- The host APP builds its own application ecosystem, which can target both a wide range of developers and some developers;
- The host APP decouples the modules through small programs, allowing the development teams of different modules to independently release versions and update flexibly;
- Some functions in the host APP are implemented using the PhizClip applet, which reduces development costs and improves release efficiency;
In addition, the SDK also needs to be used in conjunction with the basic library to provide users with a better experience through the mini program life cycle hooks, API functions, page DOM creation, rendering, event delivery and other capabilities provided by the basic library.
## 🤩 Effect preview
**This project is a DEMO demonstration of the PhizClip applet in the Win32 environment. You can test according to the following process to verify the actual effect of the PhizClip applet in the Windows environment.**
Lets take a look at the running effect first~
<p align="center">
<a href="#">
<img width="auto" src="./doc/images/450.gif">
</a>
</p>
> We have provided DEMO resources that you can download and run to get the corresponding effects. If you have relevant commercial use needs, please also contact us.
## Desktop SDK support progress
Currently, customers are supported to use C, C++, C#, python, delphi, electron to integrate PhizClip desktop SDK, and it is verified in Windows / Macos / Ubuntu / UOS
## DEMO operation and SDK integration instructions
### Step 1: Download the corresponding base package
According to your system and architecture, download the corresponding PhizClip-SDK;
If you are running Windows 32-bit, download `finclip-sdk-win-x86-x.y.z.zip` and extract it to the `vendor/win/x86` directory;
### Step 2: Download the language SDK
- For applications written in Python and JavaScript, we provide libraries for the corresponding languages;
- Applications written in C/C++ can be called directly without integrating additional support libraries;
### Step 3: Run
Check the documentation and after preparing the corresponding files, you can run PhizClip DEMO;
## View integration documentation
In the demo document, we also describe how to integrate PhizClip SDK in this language environment
## 🔗 Links
The following is information on common questions and guidelines for your development and experience with PhizClip
- [Home Page](https://www.finclip.com/#/home)
- [Example Mini-App](https://www.finclip.com/#/market)
- [Documentation](https://www.finclip.com/mop/document/)
- [SDK Integration Guide](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html)
- [Structure of PhizClip](https://www.finclip.com/mop/document/develop/guide/structure.html)
- [Integration Guidelines(iOS)](https://www.finclip.com/mop/document/runtime-sdk/ios/ios-integrate.html)
- [Integration Guidelines(Android)](https://www.finclip.com/mop/document/runtime-sdk/android/android-integrate.html)
- [Integration Guidelines(Flutter)](https://www.finclip.com/mop/document/runtime-sdk/flutter/flutter-integrate.html)
## ☎️ Contact
Scan the QR code below with WeChat and follow the official public number **Finogeeks** for more exciting content.<br>
<img width="150px" src="https://www.finclip.com/mop/document/images/ic_qr.svg">
Scan the QR code below with WeChat and invite into the official WeChat exchange group (add friend note: **finclip consulting**) to get more exciting content.<br>
<img width="150px" src="https://finclip-homeweb-1251849568.cos.ap-guangzhou.myqcloud.com/images/ldy111.jpg">
## 🌏 Languages
- [简体中文](./README.md)
- [English](./readme_en.md)
- [Português](./readme_pt.md)

113
readme_pt.md 100644
View File

@ -0,0 +1,113 @@
<p align="center">
<a href="https://www.finclip.com?from=github">
<img width="auto" src="./doc/images/phizlogo.png">
</a>
</p>
<p align="center">
<strong>PhizClip Desktop DEMO</strong></br>
<p>
<p align="center">
桌面版小程序 DEMO
<p>
<p align="center">
👉 <a href="https://www.finclip.com?from=github">https://www.phizclip.com/</a> 👈
</p>
<div align="center">
<a href="#"><img src="https://img.shields.io/badge/%E4%B8%93%E5%B1%9E%E5%BC%80%E5%8F%91%E8%80%85-20000%2B-brightgreen"></a>
<a href="#"><img src="https://img.shields.io/badge/%E5%B7%B2%E4%B8%8A%E6%9E%B6%E5%B0%8F%E7%A8%8B%E5%BA%8F-6000%2B-blue"></a>
<a href="#"><img src="https://img.shields.io/badge/%E5%B7%B2%E9%9B%86%E6%88%90%E5%B0%8F%E7%A8%8B%E5%BA%8F%E5%BA%94%E7%94%A8-75%2B-yellow"></a>
<a href="#"><img src="https://img.shields.io/badge/%E5%AE%9E%E9%99%85%E8%A6%86%E7%9B%96%E7%94%A8%E6%88%B7-2500%20%E4%B8%87%2B-orange"></a>
</div>
<p align="center">
<div align="center">
[官方网站](https://www.finclip.com/) | [示例小程序](https://www.finclip.com/#/market) | [开发文档](https://www.finclip.com/mop/document/) | [部署指南](https://www.finclip.com/mop/document/introduce/quickStart/cloud-server-deployment-guide.html) | [SDK 集成指南](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html) | [API 列表](https://www.finclip.com/mop/document/develop/api/overview.html) | [组件列表](https://www.finclip.com/mop/document/develop/component/overview.html) | [隐私承诺](https://www.finclip.com/mop/document/operate/safety.html)
</div>
-----
## 🤔 PhizClip 是什么?
有没有**想过**,开发好的微信小程序能放在自己的 APP 里直接运行,只需要开发一次小程序,就能在不同的应用中打开它,是不是很不可思议?
有没有**试过**,在自己的 APP 中引入一个 SDK ,应用中不仅可以打开小程序,还能自定义小程序接口,修改小程序样式,是不是觉得更不可思议?
这就是 FinClip ,就是有这么多不可思议!
## 🖥 PhizClip SDK 是什么?
开发者可以使用 PhizClip SDK 在宿主 APP 中快速实现小程序的能力。一般会用于以下场景:
- 宿主 APP 构建自己的应用生态,既可以面向广泛开发者,也可以定向部分开发者;
- 宿主 APP 通过小程序方式对模块进行解耦,让不同模块的开发团队独立发版,灵活更新;
- 宿主 APP 中部分功能使用 PhizClip 小程序实现,降低开发成本,并且提升发布效率;
此外SDK 还需要配合基础库一并使用通过基础库提供的小程序生命周期钩子、API函数页面 DOM创建、渲染以及事件传递等能力为用户提供更加良好的体验。
## 🤩 效果预览
**本项目是 PhizClip 小程序在 Win32 环境下的 DEMO 演示,您可以按照下方流程测试,验证 PhizClip 小程序在 Windows 环境下的实际效果。**
先看一下运行效果~
<p align="center">
<a href="#">
<img width="auto" src="./doc/images/450.gif">
</a>
</p>
> 我们已经提供了 DEMO 资源,您可以下载运行,以便获取对应的效果。如果您有相关商业化使用需求,也请与我们联系。
## 桌面版 SDK 支持进展
目前已支持客户使用 C, C++, C#, python, delphi, electron 集成 PhizClip 桌面版 SDK, 并在 Windows / Macos / Ubuntu / UOS 中验证
## DEMO 运行与 SDK 集成说明
### 第一步: 下载对应的 base 包
根据你的系统和架构, 下载对应的 PhizClip-SDK
假如你是 Windows 32 位, 则下载 `finclip-sdk-win-x86-x.y.z.zip` , 并解压至 `vendor/win/x86` 目录下;
### 第二步: 下载语言 SDK
- 对于 PythonJavaScript 编写的应用程序,我们提供了对应语言的库;
- 对于 C/C++ 编写的应用程序则可以直接调用,无须集成额外支持库;
### 第三步: 运行
查看文档,在准备好相应的文件后,即可运行 PhizClip DEMO
## 查看集成文档
在demo文档中, 我们也描述了在该语言环境下, 如何集成PhizClip SDK
## 🔗 常用链接
以下内容是您在 PhizClip 进行开发与体验时,常见的问题与指引信息
- [PhizClip 官网](https://www.finclip.com/#/home)
- [示例小程序](https://www.finclip.com/#/market)
- [文档中心](https://www.finclip.com/mop/document/)
- [SDK 部署指南](https://www.finclip.com/mop/document/introduce/quickStart/intergration-guide.html)
- [小程序代码结构](https://www.finclip.com/mop/document/develop/guide/structure.html)
- [iOS 集成指引](https://www.finclip.com/mop/document/runtime-sdk/ios/ios-integrate.html)
- [Android 集成指引](https://www.finclip.com/mop/document/runtime-sdk/android/android-integrate.html)
- [Flutter 集成指引](https://www.finclip.com/mop/document/runtime-sdk/flutter/flutter-integrate.html)
## ☎️ 联系我们
微信扫描下面二维码,关注官方公众号 **「凡泰极客」**,获取更多精彩内容。<br>
<img width="150px" src="https://www.finclip.com/mop/document/images/ic_qr.svg">
微信扫描下面二维码,加入官方微信交流群,获取更多精彩内容。<br>
<img width="150px" src="https://www-cdn.finclip.com/images/qrcode/qrcode_shequn_text.png">
## 🌏 多语言文档
- [简体中文](./README.md)
- [English](./readme_en.md)
- [Português](./readme_pt.md)