Skip to content

Commit 63e6f45

Browse files
committed
Init
1 parent 87996e6 commit 63e6f45

File tree

10 files changed

+1349
-380
lines changed

10 files changed

+1349
-380
lines changed

Cargo.lock

Lines changed: 981 additions & 28 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Cargo.toml

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[package]
2-
name = "eframe_template"
2+
name = "simu"
33
version = "0.1.0"
4-
authors = ["Emil Ernerfeldt <emil.ernerfeldt@gmail.com>"]
4+
authors = [""]
55
edition = "2024"
66
include = ["LICENSE-APACHE", "LICENSE-MIT", "**/*.rs", "Cargo.toml"]
77
rust-version = "1.85"
@@ -13,17 +13,19 @@ targets = ["x86_64-unknown-linux-gnu", "wasm32-unknown-unknown"]
1313
[dependencies]
1414
egui = "0.32"
1515
eframe = { version = "0.32", default-features = false, features = [
16-
"accesskit", # Make egui compatible with screen readers. NOTE: adds a lot of dependencies.
17-
"default_fonts", # Embed the default egui fonts.
18-
"glow", # Use the glow rendering backend. Alternative: "wgpu".
19-
"persistence", # Enable restoring app state when restarting the app.
20-
"wayland", # To support Linux (and CI)
21-
"x11", # To support older Linux distributions (restores one of the default features)
16+
"accesskit", # Make egui compatible with screen readers. NOTE: adds a lot of dependencies.
17+
"default_fonts", # Embed the default egui fonts.
18+
"glow", # Use the glow rendering backend. Alternative: "wgpu".
19+
"persistence", # Enable restoring app state when restarting the app.
20+
"wayland", # To support Linux (and CI)
21+
"x11", # To support older Linux distributions (restores one of the default features)
2222
] }
2323
log = "0.4.27"
2424

2525
# You only need serde if you want app persistence:
2626
serde = { version = "1.0.219", features = ["derive"] }
27+
egui_extras = { version = "0.32.1", features = ["all_loaders"] }
28+
image = "0.25.6"
2729

2830
# native:
2931
[target.'cfg(not(target_arch = "wasm32"))'.dependencies]
@@ -53,10 +55,14 @@ opt-level = 2
5355
# eframe = { path = "../egui/crates/eframe" }
5456

5557

56-
5758
# ----------------------------------------------------------------------------------------
5859
# Lints:
5960

61+
[features]
62+
default = []
63+
wasm = []
64+
65+
6066
[lints]
6167
workspace = true
6268

@@ -96,12 +102,12 @@ cloned_instead_of_copied = "warn"
96102
dbg_macro = "warn"
97103
debug_assert_with_mut_call = "warn"
98104
derive_partial_eq_without_eq = "warn"
99-
disallowed_macros = "warn" # See clippy.toml
100-
disallowed_methods = "warn" # See clippy.toml
101-
disallowed_names = "warn" # See clippy.toml
102-
disallowed_script_idents = "warn" # See clippy.toml
103-
disallowed_types = "warn" # See clippy.toml
104-
doc_include_without_cfg = "warn"
105+
disallowed_macros = "warn" # See clippy.toml
106+
disallowed_methods = "warn" # See clippy.toml
107+
disallowed_names = "warn" # See clippy.toml
108+
disallowed_script_idents = "warn" # See clippy.toml
109+
disallowed_types = "warn" # See clippy.toml
110+
doc_include_without_cfg = "warn"
105111
doc_link_with_quotes = "warn"
106112
doc_markdown = "warn"
107113
empty_enum = "warn"
@@ -236,5 +242,5 @@ wildcard_dependencies = "warn"
236242
wildcard_imports = "warn"
237243
zero_sized_map_values = "warn"
238244

239-
manual_range_contains = "allow" # this is better on 'allow'
240-
map_unwrap_or = "allow" # this is better on 'allow'
245+
manual_range_contains = "allow" # this is better on 'allow'
246+
map_unwrap_or = "allow" # this is better on 'allow'

README.md

Lines changed: 0 additions & 85 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +0,0 @@
1-
# eframe template
2-
3-
[![dependency status](https://deps.rs/repo/github/emilk/eframe_template/status.svg)](https://deps.rs/repo/github/emilk/eframe_template)
4-
[![Build Status](https://github.com/emilk/eframe_template/workflows/CI/badge.svg)](https://github.com/emilk/eframe_template/actions?workflow=CI)
5-
6-
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.
36-
37-
### Testing locally
38-
39-
`cargo run --release`
40-
41-
On Linux you need to first run:
42-
43-
`sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev`
44-
45-
On Fedora Rawhide you need to run:
46-
47-
`dnf install clang clang-devel clang-tools-extra libxkbcommon-devel pkg-config openssl-devel libxcb-devel gtk3-devel atk fontconfig-devel`
48-
49-
### Web Locally
50-
51-
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).

assets/nand.svg

Lines changed: 2 additions & 0 deletions
Loading

assets/sw.js

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,20 @@
1-
var cacheName = 'egui-template-pwa';
2-
var filesToCache = [
3-
'./',
4-
'./index.html',
5-
'./eframe_template.js',
6-
'./eframe_template_bg.wasm',
7-
];
1+
var cacheName = "egui-template-pwa";
2+
var filesToCache = ["./", "./index.html", "./simu.js", "./simu_bg.wasm"];
83

94
/* Start the service worker and cache all of the app's content */
10-
self.addEventListener('install', function (e) {
5+
self.addEventListener("install", function (e) {
116
e.waitUntil(
127
caches.open(cacheName).then(function (cache) {
138
return cache.addAll(filesToCache);
14-
})
9+
}),
1510
);
1611
});
1712

1813
/* Serve cached content when offline */
19-
self.addEventListener('fetch', function (e) {
14+
self.addEventListener("fetch", function (e) {
2015
e.respondWith(
2116
caches.match(e.request).then(function (response) {
2217
return response || fetch(e.request);
23-
})
18+
}),
2419
);
2520
});

fill_template.ps1

Lines changed: 0 additions & 13 deletions
This file was deleted.

fill_template.sh

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)