diff --git a/CHANGELOG.md b/CHANGELOG.md index d22b63f3c..50a014a7e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,7 +12,7 @@ There are 5 types of changes: - `Documented` for any changes to the documentation. - `Breaking` for the detail of any backward incompatible changes. -And please only add new entries below the [Unreleased](#unreleased---releasedate) header with the following format: +Please only add new entries below the [Unreleased](#unreleased---releasedate) header with the following format: ```md **crate or effect scope**: description of change (#PR @contributor) @@ -24,11 +24,13 @@ And please only add new entries below the [Unreleased](#unreleased---releasedate 🎉🎉🎉 The first version of Ribir. -![background](https://not.ready/demos.png) +![background](./docs/assets/hero-banner.png) -As the first version, its main content is to verify and stabilize the basic concepts, determine the overall framework process, and make preliminary attempts to verify all core modules. +The goal of this version of Ribir is to finish the core framework and answer our questions about the feasibility of the design. -We use it in our own projects and have a good experience, and we hope you can also try it out and give us feedback. But it is still in a very rough stage, and be careful to use it in production. +We use it to build examples and build some apps for our daily work. And we are satisfied with the experience of using it. + +We are very happy to share it with you. We hope you can try it out and give us feedback. But we don't recommend you to use it in production environments yet. ### Features diff --git a/README.md b/README.md index f170ced68..7e9a0509d 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,10 @@ Use Rust to build multi-platform applications from a single codebase. [Website] | [Documents] | [Examples] | [Changelog] - +![](./docs/assets/hero-banner.png) + ## What's Ribir? Ribir is a Rust GUI framework that helps you build beautiful and native multi-platform applications from a single codebase. @@ -64,7 +65,6 @@ fn main() { More [Examples] - ## Features - **Declarative language** does not introduce a fully new language but rather provides a set of Rust macros for easy interaction. @@ -82,6 +82,10 @@ More [Examples] - **Text** support basic text typography and IME input, in a usable but rough stage. - **Widgets** library provides 20+ basic widgets, but all are in a rough stage, and the API is not stable yet. +## Architecture overview + +![](./docs/assets/architecture.svg) + ## Support Platform |Platform|Support situation| diff --git a/docs/advanced_topics/_category_.json b/docs/advanced_topics/_category_.json deleted file mode 100644 index cbc86d70c..000000000 --- a/docs/advanced_topics/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Advanced Topics", - "position": 6, - "link": { - "type": "generated-index", - "description": "Advanced Topics" - } -} diff --git a/docs/advanced_topics/architecture.md b/docs/advanced_topics/architecture.md deleted file mode 100644 index 934c62441..000000000 --- a/docs/advanced_topics/architecture.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -sidebar_position: 1 ---- - -# Architecture diff --git a/docs/assets/architecture.svg b/docs/assets/architecture.svg new file mode 100644 index 000000000..4fce1bd32 --- /dev/null +++ b/docs/assets/architecture.svg @@ -0,0 +1 @@ + DSLWidgetsCompositionLayoutPainterCore FrameworkFutures SchedulerFor DevelopersThemesFuturesWidget TreeEvent Dispatcher Render GPU RenderYou have the option to use another 2D render, or convert the path into SVG, HTML and so on. It's up to you. Platform-SepcificTessellationTexture cachewgpu implementationOther GPU implementationRibir does not supplythe gray block, you  need to implement ityourself.WinitApp bundleNative  APIsAnimation \ No newline at end of file diff --git a/docs/assets/hero-banner.png b/docs/assets/hero-banner.png new file mode 100644 index 000000000..fd13acb9b Binary files /dev/null and b/docs/assets/hero-banner.png differ diff --git a/docs/essentials/_category_.json b/docs/essentials/_category_.json deleted file mode 100644 index 0de8bc4fb..000000000 --- a/docs/essentials/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Essentials", - "position": 3, - "link": { - "type": "generated-index", - "description": "Essentials" - } -} diff --git a/docs/essentials/application_theme.md b/docs/essentials/application_theme.md deleted file mode 100644 index f92e46c04..000000000 --- a/docs/essentials/application_theme.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -sidebar_position: 3 ---- - -# Application Theme diff --git a/docs/essentials/understand_ribir.md b/docs/essentials/understand_ribir.md deleted file mode 100644 index 529bf54dc..000000000 --- a/docs/essentials/understand_ribir.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -sidebar_position: 2 ---- - -# Understand Ribir diff --git a/docs/project_practice/_category_.json b/docs/project_practice/_category_.json deleted file mode 100644 index 36e647386..000000000 --- a/docs/project_practice/_category_.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "label": "Project Practice", - "position": 5, - "link": { - "type": "generated-index", - "description": "Project Practice" - } -} diff --git a/docs/project_practice/img/todo_example.png b/docs/project_practice/img/todo_example.png deleted file mode 100644 index 695f4bbe9..000000000 Binary files a/docs/project_practice/img/todo_example.png and /dev/null differ diff --git a/docs/project_practice/more_example.md b/docs/project_practice/more_example.md deleted file mode 100644 index d956aaa20..000000000 --- a/docs/project_practice/more_example.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -sidebar_position: 2 ---- - -# More Example