Skip to content
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.

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

docs(ribir): ✏️ update changelog & readme #506

Merged
merged 1 commit into from
Dec 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 6 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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

Expand Down
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,10 @@ Use Rust to build multi-platform applications from a single codebase.

[Website] | [Documents] | [Examples] | [Changelog]

<!--todo: a demos picture here-->
</div>

![](./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.
Expand Down Expand Up @@ -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.
Expand All @@ -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|
Expand Down
8 changes: 0 additions & 8 deletions docs/advanced_topics/_category_.json

This file was deleted.

5 changes: 0 additions & 5 deletions docs/advanced_topics/architecture.md

This file was deleted.

1 change: 1 addition & 0 deletions docs/assets/architecture.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/hero-banner.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 0 additions & 8 deletions docs/essentials/_category_.json

This file was deleted.

5 changes: 0 additions & 5 deletions docs/essentials/application_theme.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/essentials/understand_ribir.md

This file was deleted.

8 changes: 0 additions & 8 deletions docs/project_practice/_category_.json

This file was deleted.

Binary file removed docs/project_practice/img/todo_example.png
Binary file not shown.
5 changes: 0 additions & 5 deletions docs/project_practice/more_example.md

This file was deleted.