Skip to content

Commit f3ce390

Browse files
committed
Updated dependences versions, readme
1 parent 868767b commit f3ce390

3 files changed

Lines changed: 40 additions & 22 deletions

File tree

LICENSE-MIT

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Max Zhuk
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
![EFX — Rust templating for egui/eframe](https://raw.githubusercontent.com/ZhukMax/efx/main/efx/docs/efx_cover.png)
22

33
# EFx
4+
**🧑‍💻 Easy as HTML, 🚀 Fast as C, 🔐 Safe cause Rust**
5+
46
[![Crates.io](https://img.shields.io/crates/v/efx.svg?color=green)](https://crates.io/crates/efx)
57
![Crates.io Version](https://img.shields.io/crates/v/efx-core?label=efx-core)
68
![Crates.io Version](https://img.shields.io/crates/v/efx-attrnames?label=efx-attrnames&color=red)
@@ -12,21 +14,23 @@
1214
**EFx** — Rust 🦀 XML Template Engine for [egui](https://github.com/emilk/egui)-based frameworks: [eframe](https://github.com/emilk/egui/tree/master/crates/eframe), [bevy_egui](https://github.com/vladbat00/bevy_egui), [egui-winit](https://crates.io/crates/egui-winit), [egui-miniquad](https://github.com/not-fl3/egui-miniquad).
1315
`efx!` is a proc-macro for writing tiny XML-like UI snippets in `eframe/egui`. It converts short tags into `egui` calls.
1416

15-
**Simplicity and Convenience — XML, 🚀 Speed and 🔐 Security — Rust**
16-
17-
**Easy as HTML, Fast as C**
17+
**What EFx is great for**
1818

19-
You can embed arbitrary Rust expressions inside braces (`{...}`).
19+
* 🖥️ **Desktop applications** — configuration panels, launchers, developer tools, dashboards.
20+
* 🎮 **Game development** — in-game menus, HUDs, editors, and overlays using `bevy_egui`.
21+
* 🌐 **WebAssembly apps** — single-page Rust apps that render via `eframe` in `<canvas>`.
22+
* 🧰 **Internal tools** — property editors, inspectors, debug panels, and other utility UIs.
23+
* 🔬 **Visualization** — scientific dashboards, data explorers, and control interfaces for simulations.
2024

2125
---
2226

2327
### Install & import
2428

25-
Requires `egui` (the project currently uses `egui 0.32`). Add to `Cargo.toml`:
29+
Requires `egui` (the project currently uses `egui 0.33`). Add to `Cargo.toml`:
2630
```toml
2731
[dependencies]
28-
efx = "0.6"
29-
egui = "0.32" # or egui-based framework
32+
efx = "0.7"
33+
egui = "0.33" # or egui-based framework
3034
```
3135

3236
Inside this repo just import the macro:
@@ -90,15 +94,8 @@ At compile time the macro parses your snippet; at runtime it shows readable diag
9094
### Roadmap & RFCs
9195

9296
**TL;DR.** EFx is a minimalist XML DSL on top of `egui` that compiles to plain `ui.*` calls.
93-
The next three releases focus on expressiveness and first-class examples across popular `egui` runtimes:
94-
95-
* **0.7 — Themes & layouts:** lightweight style sheets, extended containers (`Tabs/Table` behind `extras`), perf & polish.
96-
97-
This plan is incremental and **non-breaking**; new features are opt-in. Priorities may change based on community feedback.
98-
99-
👉 **Full RFC:** [EFX-0001 — Roadmap 0.5–0.7](efx/docs/rfcs/EFX-0001-roadmap-0.5-0.7.md)
10097

101-
👉 **RFC index:** [RFC/README.md](efx/docs/rfcs/README.md)
98+
**RFC index:** [RFC/README.md](efx/docs/rfcs/README.md)
10299

103100
---
104101

@@ -126,7 +123,7 @@ EFx renders into any runtime that provides `&mut egui::Ui`. We officially build
126123
# Cargo.toml
127124
[dependencies]
128125
efx = "0.7"
129-
eframe = "0.32"
126+
eframe = "0.33"
130127
```
131128

132129
```rust
@@ -165,7 +162,7 @@ bevy_egui::egui::Window::new("EFx").show(egui_ctx.ctx_mut(), |ui| {
165162
# Cargo.toml
166163
[dependencies]
167164
efx = "0.7"
168-
egui = "0.32"
165+
egui = "0.33"
169166
egui-winit = "0.32"
170167
egui-wgpu = "0.32"
171168
winit = "0.30"

efx/Cargo.toml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,24 +44,24 @@ quote = "1.0"
4444
proc-macro2 = "1.0"
4545
efx-core = { workspace = true }
4646
efx-attrnames = { workspace = true }
47-
egui = "0.32"
48-
egui_extras = { version = "0.32", optional = true }
47+
egui = "0.33.0"
48+
egui_extras = { version = "0.33.0", optional = true }
4949

5050
[dev-dependencies]
5151
efx-core = { workspace = true, features = ["doc-prelude"] }
5252
efx-attrnames = { workspace = true }
5353
trybuild = "1.0"
5454
# For the eframe example
55-
eframe = "0.32"
55+
eframe = "0.33.0"
5656
# For the bevy_egui example
57-
bevy = { version = "0.16", default-features = false, features = [
57+
bevy = { version = "0.17.2", default-features = false, features = [
5858
"bevy_winit",
5959
"bevy_render",
6060
"bevy_ui",
6161
"png",
6262
"x11"
6363
] }
64-
bevy_egui = { version = "0.36", default-features = false }
64+
bevy_egui = { version = "0.38.0", default-features = false }
6565
# for wasm entrypoint
6666
wasm-bindgen = "0.2"
6767
wasm-bindgen-futures = "0.4"

0 commit comments

Comments
 (0)