You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This is a template repo for [eframe](https://github.com/emilk/egui/tree/master/crates/eframe), a framework for writing apps using [egui](https://github.com/emilk/egui/).
7
-
8
-
The goal is for this to be the simplest way to get started writing a GUI app in Rust.
9
-
10
-
You can compile your app natively or for the web, and share it using Github Pages.
11
-
12
-
## Getting started
13
-
14
-
Start by clicking "Use this template" at https://github.com/emilk/eframe_template/ or follow [these instructions](https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/creating-a-repository-from-a-template).
15
-
16
-
Change the name of the crate: Choose a good name for your project, and change the name to it in:
17
-
*`Cargo.toml`
18
-
* Change the `package.name` from `eframe_template` to `your_crate`.
19
-
* Change the `package.authors`
20
-
*`main.rs`
21
-
* Change `eframe_template::TemplateApp` to `your_crate::TemplateApp`
22
-
*`index.html`
23
-
* Change the `<title>eframe template</title>` to `<title>your_crate</title>`. optional.
24
-
*`assets/sw.js`
25
-
* Change the `'./eframe_template.js'` to `./your_crate.js` (in `filesToCache` array)
26
-
* Change the `'./eframe_template_bg.wasm'` to `./your_crate_bg.wasm` (in `filesToCache` array)
27
-
28
-
Alternatively, you can run `fill_template.sh` which will ask for the needed names and email and perform the above patches for you. This is particularly useful if you clone this repository outside GitHub and hence cannot make use of its
29
-
templating function.
30
-
31
-
### Learning about egui
32
-
33
-
`src/app.rs` contains a simple example app. This is just to give some inspiration - most of it can be removed if you like.
34
-
35
-
The official egui docs are at <https://docs.rs/egui>. If you prefer watching a video introduction, check out <https://www.youtube.com/watch?v=NtUkr_z7l84>. For inspiration, check out the [the egui web demo](https://emilk.github.io/egui/index.html) and follow the links in it to its source code.
You can compile your app to [WASM](https://en.wikipedia.org/wiki/WebAssembly) and publish it as a web page.
52
-
53
-
We use [Trunk](https://trunkrs.dev/) to build for web target.
54
-
1. Install the required target with `rustup target add wasm32-unknown-unknown`.
55
-
2. Install Trunk with `cargo install --locked trunk`.
56
-
3. Run `trunk serve` to build and serve on `http://127.0.0.1:8080`. Trunk will rebuild automatically if you edit the project.
57
-
4. Open `http://127.0.0.1:8080/index.html#dev` in a browser. See the warning below.
58
-
59
-
> `assets/sw.js` script will try to cache our app, and loads the cached version when it cannot connect to server allowing your app to work offline (like PWA).
60
-
> appending `#dev` to `index.html` will skip this caching, allowing us to load the latest builds during development.
61
-
62
-
### Web Deploy
63
-
1. Just run `trunk build --release`.
64
-
2. It will generate a `dist` directory as a "static html" website
65
-
3. Upload the `dist` directory to any of the numerous free hosting websites including [GitHub Pages](https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site).
66
-
4. we already provide a workflow that auto-deploys our app to GitHub pages if you enable it.
67
-
> To enable Github Pages, you need to go to Repository -> Settings -> Pages -> Source -> set to `gh-pages` branch and `/` (root).
68
-
>
69
-
> If `gh-pages` is not available in `Source`, just create and push a branch called `gh-pages` and it should be available.
70
-
>
71
-
> If you renamed the `main` branch to something else (say you re-initialized the repository with `master` as the initial branch), be sure to edit the github workflows `.github/workflows/pages.yml` file to reflect the change
72
-
> ```yml
73
-
> on:
74
-
> push:
75
-
> branches:
76
-
> - <branch name>
77
-
> ```
78
-
79
-
You can test the template app at <https://emilk.github.io/eframe_template/>.
80
-
81
-
## Updating egui
82
-
83
-
As of 2023, egui is in active development with frequent releases with breaking changes. [eframe_template](https://github.com/emilk/eframe_template/) will be updated in lock-step to always use the latest version of egui.
84
-
85
-
When updating `egui` and `eframe` it is recommended you do so one version at the time, and read about the changes in [the egui changelog](https://github.com/emilk/egui/blob/master/CHANGELOG.md) and [eframe changelog](https://github.com/emilk/egui/blob/master/crates/eframe/CHANGELOG.md).
0 commit comments