From 4a9ebe78d7d41ae79a551e3a9a560bba22894e25 Mon Sep 17 00:00:00 2001 From: Evan Almloff Date: Tue, 11 Apr 2023 11:22:36 -0500 Subject: [PATCH] fix Linux CI dependancies --- .github/workflows/main.yml | 6 +++--- docs/guide/src/en/getting_started/desktop.md | 15 ++++++++------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 96649c9036..a3bff9fc63 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -39,7 +39,7 @@ jobs: override: true - uses: Swatinem/rust-cache@v2 - run: sudo apt-get update - - run: sudo apt install libwebkit2gtk-4.0-dev libgtk-3-dev libayatana-appindicator3-dev + - run: sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev - uses: actions/checkout@v3 - uses: actions-rs/cargo@v1 with: @@ -58,7 +58,7 @@ jobs: override: true - uses: Swatinem/rust-cache@v2 - run: sudo apt-get update - - run: sudo apt install libwebkit2gtk-4.0-dev libgtk-3-dev libayatana-appindicator3-dev + - run: sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev - uses: davidB/rust-cargo-make@v1 - uses: browser-actions/setup-firefox@latest - uses: jetli/wasm-pack-action@v0.4.0 @@ -98,7 +98,7 @@ jobs: override: true - uses: Swatinem/rust-cache@v2 - run: sudo apt-get update - - run: sudo apt install libwebkit2gtk-4.0-dev libgtk-3-dev libayatana-appindicator3-dev + - run: sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev - run: rustup component add clippy - uses: actions/checkout@v3 - uses: actions-rs/cargo@v1 diff --git a/docs/guide/src/en/getting_started/desktop.md b/docs/guide/src/en/getting_started/desktop.md index 311ad2c9f1..b242152188 100644 --- a/docs/guide/src/en/getting_started/desktop.md +++ b/docs/guide/src/en/getting_started/desktop.md @@ -5,6 +5,7 @@ Build a standalone native desktop app that looks and feels the same across opera Apps built with Dioxus are typically <5mb in size and use existing system resources, so they won't hog extreme amounts of RAM or memory. Examples: + - [File Explorer](https://github.com/DioxusLabs/example-projects/blob/master/file-explorer) - [WiFi Scanner](https://github.com/DioxusLabs/example-projects/blob/master/wifi-scanner) @@ -12,21 +13,22 @@ Examples: ## Support -The desktop is a powerful target for Dioxus but is currently limited in capability when compared to the Web platform. Currently, desktop apps are rendered with the platform's WebView library, but your Rust code is running natively on a native thread. This means that browser APIs are *not* available, so rendering WebGL, Canvas, etc is not as easy as the Web. However, native system APIs *are* accessible, so streaming, WebSockets, filesystem, etc are all viable APIs. In the future, we plan to move to a custom web renderer-based DOM renderer with WGPU integrations. +The desktop is a powerful target for Dioxus but is currently limited in capability when compared to the Web platform. Currently, desktop apps are rendered with the platform's WebView library, but your Rust code is running natively on a native thread. This means that browser APIs are _not_ available, so rendering WebGL, Canvas, etc is not as easy as the Web. However, native system APIs _are_ accessible, so streaming, WebSockets, filesystem, etc are all viable APIs. In the future, we plan to move to a custom web renderer-based DOM renderer with WGPU integrations. Dioxus Desktop is built off [Tauri](https://tauri.app/). Right now there aren't any Dioxus abstractions over the menubar, handling, etc, so you'll want to leverage Tauri – mostly [Wry](http://github.com/tauri-apps/wry/) and [Tao](http://github.com/tauri-apps/tao)) directly. # Getting started ## Platform-Specific Dependencies + Dioxus desktop renders through a web view. Depending on your platform, you might need to install some dependancies. ### Windows -Windows Desktop apps depend on WebView2 – a library that should be installed in all modern Windows distributions. If you have Edge installed, then Dioxus will work fine. If you *don't* have Webview2, [then you can install it through Microsoft](https://developer.microsoft.com/en-us/microsoft-edge/webview2/). MS provides 3 options: +Windows Desktop apps depend on WebView2 – a library that should be installed in all modern Windows distributions. If you have Edge installed, then Dioxus will work fine. If you _don't_ have Webview2, [then you can install it through Microsoft](https://developer.microsoft.com/en-us/microsoft-edge/webview2/). MS provides 3 options: -1. A tiny "evergreen" *bootstrapper* that fetches an installer from Microsoft's CDN -2. A tiny *installer* that fetches Webview2 from Microsoft's CDN +1. A tiny "evergreen" _bootstrapper_ that fetches an installer from Microsoft's CDN +2. A tiny _installer_ that fetches Webview2 from Microsoft's CDN 3. A statically linked version of Webview2 in your final binary for offline users For development purposes, use Option 1. @@ -36,19 +38,18 @@ For development purposes, use Option 1. Webview Linux apps require WebkitGtk. When distributing, this can be part of your dependency tree in your `.rpm` or `.deb`. However, likely, your users will already have WebkitGtk. ```bash -sudo apt install libwebkit2gtk-4.0-dev libgtk-3-dev libappindicator3-dev +sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev ``` When using Debian/bullseye `libappindicator3-dev` is no longer available but replaced by `libayatana-appindicator3-dev`. ```bash # on Debian/bullseye use: -sudo apt install libwebkit2gtk-4.0-dev libgtk-3-dev libayatana-appindicator3-dev +sudo apt install libwebkit2gtk-4.1-dev libgtk-3-dev libayatana-appindicator3-dev ``` If you run into issues, make sure you have all the basics installed, as outlined in the [Tauri docs](https://tauri.studio/v1/guides/getting-started/prerequisites#setting-up-linux). - ### MacOS Currently – everything for macOS is built right in! However, you might run into an issue if you're using nightly Rust due to some permissions issues in our Tao dependency (which have been resolved but not published).