Skip to content

Commit

Permalink
Add note about installing cargo generate.
Browse files Browse the repository at this point in the history
Use code blocks to allow click-copying code from github.
  • Loading branch information
armandas committed Nov 24, 2024
1 parent 62e65d8 commit 8ee6b18
Showing 1 changed file with 19 additions and 5 deletions.
24 changes: 19 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,17 @@ You can compile your app natively or for the web, and share it using Github Page

## Getting started

To get started, run:
If you don't have [`cargo-generate`](https://github.com/cargo-generate/cargo-generate) installed yet, install it with:

`cargo generate --git https://github.com/emilk/eframe_template`
```sh
cargo install cargo-generate
```

Then create a project by running:

```sh
cargo generate --git https://github.com/emilk/eframe_template
```

### Learning about egui

Expand All @@ -25,15 +33,21 @@ The official egui docs are at <https://docs.rs/egui>. If you prefer watching a v

Make sure you are using the latest version of stable rust by running `rustup update`.

`cargo run --release`
```sh
cargo run --release
```

On Linux you need to first run:

`sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev`
```sh
sudo apt-get install libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev libxkbcommon-dev libssl-dev
```

On Fedora Rawhide you need to run:

`dnf install clang clang-devel clang-tools-extra libxkbcommon-devel pkg-config openssl-devel libxcb-devel gtk3-devel atk fontconfig-devel`
```sh
dnf install clang clang-devel clang-tools-extra libxkbcommon-devel pkg-config openssl-devel libxcb-devel gtk3-devel atk fontconfig-devel
```

### Web Locally

Expand Down

0 comments on commit 8ee6b18

Please sign in to comment.