diff --git a/.github/overview.png b/.github/overview.png new file mode 100644 index 000000000..34ecc9cf7 Binary files /dev/null and b/.github/overview.png differ diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b8831994e..6f35be597 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,9 +24,9 @@ cargo +nightly fmt --all -- --error-on-unformatted --unstable-features Freya is split in various crates, each with it's own meaning and purpose, here is the list sorted by their importance: - `freya`: Entrypoint to the library used by end users, mainly reexports the other crates and contains the launch methods. -- `renderer`: GUI Renderer using Winit and a Skia Canvas to render the app. -- `core`: Core logic for events, DOM processing, accessibility integration and text layout measurement is located here. -- `native-core`: DOM tree-like data structure to hold all the nodes with their attribute values and registered event handlers. +- `renderer`: Provides a winit event loop based execution for the app. +- `core`: Core logic for events, DOM processing, accessibility integration, element rendering and text layout measurement is located here. +- `native-core`: DOM data structure to hold all the nodes with their attribute values and registered event handlers. - `torin`: UI layout library specifically made for Freya, although it's agnostic. - `hooks`: Various Dioxus hooks to be used in Freya apps (text editing, animation, theming, etc) - `components`: Collection of built-in Dioxus components to be used out of the box with in Freya apps (Button, Switch, Slider, Table, ScrollView, etc) @@ -38,6 +38,8 @@ Freya is split in various crates, each with it's own meaning and purpose, here i - `native-core-macro`: Just some internal macros to be used in `states` so it can be integrated with `native-core`. - `common`: Some simple utilities used across the different Freya crates. +![Overview](./.github/overview.png) + ## Examples All important examples are located in the `./examples` folder although you might also find some in the form of docs comments in the code itself. diff --git a/README.md b/README.md index e82cce5fa..93233e2ba 100644 --- a/README.md +++ b/README.md @@ -86,11 +86,14 @@ Add Freya and Dioxus as dependencies: freya = "0.2" dioxus = { version = "0.5", features = ["macro", "hooks"], default-features = false } ``` +### Contributing πŸ§™β€β™‚οΈ + +If you are interested in contributing please make sure to have read the [Contributing](CONTRIBUTING.md) guide first! ### Features ✨ - ⛏️ Built-in **components** (button, scroll views, switch and more) -- πŸš‡ Built-in **hooks** library (animations, text editing and more) -- πŸ” Built-in **devtools** panel +- πŸš‡ Built-in **hooks** (animations, text editing and more) +- πŸ” Built-in **developer tools** (tree inspection, fps overlay) - 🧰 Built-in **headless runner** to test UI - 🎨 **Theming** support - πŸ›©οΈ **Cross-platform** (Windows, Linux, MacOS) @@ -107,9 +110,11 @@ dioxus = { version = "0.5", features = ["macro", "hooks"], default-features = fa - Useful testing APIs - Useful and extensible built-in components and hooks -### Sponsors πŸ€— +### Support πŸ€— + +If you are interested in supporting the development of this project feel free to donate to my [Github Sponsor](https://github.com/sponsors/marc2332/) page. -Thanks to my sponsors for supporting this project! πŸ˜„ +Thanks to my sponsors for supporting this project! πŸ˜„ ι«˜εΊ†δΈ°