tianzixuan/Doric
Archived
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

readme in english

Browse Source
This commit is contained in:
王劲鹏 2021-09-07 14:36:31 +08:00 committed by osborn
parent 2596476ea4
commit ebdab41e0e
1 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
README.md
View File

@ -31,51 +31,51 @@
</div> </div>
# Doric # Doric
Doric是一套高性能的跨平台开发框架,使用TSX/TypeScript开发,一套代码可在不同平台展示出同样的页面. Doric is a high-performance framework for cross-platform development. With TSX or TypeScript, a set of code can perform consistently across different platforms.
## 特色 ## Feature
### 跨平台统一 ### Cross-platform consistency
Doric目前已支持Android、iOS、Qt、Web,可通过一套代码在各平台展示一致的前端页面. Doric supports Android, iOS, Qt & Web, implements 'write once, run anywhere, perform consistently' across different platforms.
### 高性能渲染 ### High-performance rendering
Doric渲染视图时使用原生组件,在API上遵循原生接口,在架构上采用脏值检测、局部更新等多种机制实现JS与原生间的高效通信,Doric页面的渲染及运行性能可真正达到与原生媲美. Doric adopts native components or widgets on rendering views, provides a set of APIs under native standard. Doric architecture has multiple inner mechanism for efficient communication between 'Native' & 'JS', such as dirty-value detection、local-update on views, thus Doric pages will rival native pages on performance when rendering.
### 轻量化,易扩展 ### Light-weight & Easy-extensible
Doric中遵循轻量化的原则,SDK提供核心能力及通用的视图组件和平台的原生能力模块,可以满足常用的需求. Doric SDK follows fundamental principles, its core provides universal views, components and native modules, which can properly satisfy most scenarios.
同时,Doric中也提供了完备的插件机制,您可以通过注册插件来向Doric中提供视图组件或原生能力. Moreover, Doric provides an integral mechanism for plugin development, you can register your libraries or plugins with Doric API to provide view components or other native abilities.
### 易上手,丰富的工具链 ### Easy to get started with sufficient toolchains
Doric提供脚手架工具`doric-cli`及开发调试工具`Devkit`,提供热重载、断点调试、性能瀑布图、节点查看器等多种工具,帮助开发者更方便快捷地开发页面,并进行分析调试. Doric includes a scaffolding tool `doric-cli` and a debug tool `Devkit`, offering multiple tools, such as hot-reload、breakpoint debugging、waterfall-like performance profile、tree nodes viewer and so on, aiming at assisting developers building user interfaces, analyzing and debugging efficiently.
## 快速使用 ## Get started
> 项目文档: [https://doric.pub](https://doric.pub) > Documentation: [https://doric.pub](https://doric.pub)
* 您可以直接打开网页[Doric Playgroud](https://p.doric.pub/play/?e=167#example/HelloDoric.ts)快速体验Doric中的风格 * Open the web page directly: [Doric Playgroud](https://p.doric.pub/play/?e=167#example/HelloDoric.ts) and experience coding style rapidly
* 您可以通过`doric-cli`命令行工具直接创建Doric应用,可参考[安装使用](https://doric.pub/docs/index.html#%E5%AE%89%E8%A3%85Doric) * With `doric-cli` command line interfaces, you can create Doric applications, reference here by [Installation & Usage](https://doric.pub/docs/index.html#%E5%AE%89%E8%A3%85Doric)
* 如果您需要在现有Android项目中接入使用Doric,可参考[在Android中使用Doric](https://doric.pub/api/android.html) * Use Doric in your existing Android project, reference here by [Use Doric in Android](https://doric.pub/api/android.html)
* 如果您需要在现有iOS项目中接入使用Doric,可参考[在iOS中使用Doric](https://doric.pub/api/ios.html) * Use Doric in your existing iOS project, reference here by [Use Doric in iOS](https://doric.pub/api/ios.html)
## 示例代码 ## Example code
您可以通过下方代码体验Doric中的编写风格 With the following different ways to experience code style in Doric
### 声明式UI ### Declarative UI
您可以根据喜好,使用TypeScript或TSX语法书写布局. Use TypeScript or TSX to write layout ui according to your preferences.
| TypeScript | TSX | | TypeScript | TSX |
| ---- | ---- | | ---- | ---- |
| <img src="https://user-images.githubusercontent.com/9526211/132191388-6e3740ce-2ad6-4847-86f4-a1f94a5a3a77.png" height="300px" /> | <img src="https://user-images.githubusercontent.com/9526211/132192041-bb547cb8-574b-44bb-9d8f-071f4e235f3a.png" height="300px"/>| | <img src="https://user-images.githubusercontent.com/9526211/132191388-6e3740ce-2ad6-4847-86f4-a1f94a5a3a77.png" height="300px" /> | <img src="https://user-images.githubusercontent.com/9526211/132192041-bb547cb8-574b-44bb-9d8f-071f4e235f3a.png" height="300px"/>|
### 跨平台统一 ### Cross-platform consistency
下图为代码在Android及iOS应用上的运行截图 Snapshots on Android & iOS applications written in Doric
| Android | iOS | | Android | iOS |
| ---- | ---- | | ---- | ---- |
| !<img src="https://user-images.githubusercontent.com/9526211/132187361-dcafe2d1-120a-4145-ab98-3836b378576e.png" height="500px"/> | <img src="https://user-images.githubusercontent.com/9526211/132191681-0512abd2-0692-4e4f-9605-bf24d9b898c2.png" height="500px"/>| | !<img src="https://user-images.githubusercontent.com/9526211/132187361-dcafe2d1-120a-4145-ab98-3836b378576e.png" height="500px"/> | <img src="https://user-images.githubusercontent.com/9526211/132191681-0512abd2-0692-4e4f-9605-bf24d9b898c2.png" height="500px"/>|
## 常用插件库 ## Plugin library in common use
### [DoricFs](https://github.com/doric-pub/DoricFs) ### [DoricFs](https://github.com/doric-pub/DoricFs)
提供平台中读写文件系统的能力(Android+iOS) Ability provided with file system read-write on different platforms. (Android+iOS)
### [DoricWebSocket](https://github.com/doric-pub/DoricWebSocket) ### [DoricWebSocket](https://github.com/doric-pub/DoricWebSocket)
提供WebSocket能力支持(Android+iOS) Ability provided with web socket support. (Android+iOS)
### [DoricImagePicker](https://github.com/doric-pub/DoricImagePicker) ### [DoricImagePicker](https://github.com/doric-pub/DoricImagePicker)
提供图片选择及拍照功能(Android+iOS) Ability provided with image picker and photograph. (Android+iOS)
### [DoricBarcodeScanner](https://github.com/doric-pub/DoricBarcodeScanner) ### [DoricBarcodeScanner](https://github.com/doric-pub/DoricBarcodeScanner)
提供扫码支持(Android+iOS) Support for scanning bar code. (Android+iOS)
### [DoricSQLite](https://github.com/doric-pub/DoricSQLite) ### [DoricSQLite](https://github.com/doric-pub/DoricSQLite)
提供SQLite数据库支持(Android+iOS) Provided with SQLite database manipulation. (Android+iOS)
## License ## License