中文文档

Introduction

It's a Rust template project for Slint GUI. It cantains frequently-used components, setting panel, configure, simple database feature and other somall feature. This project can be compiled to Desktop (Windows, Linix, Macos), Android and Web platform.

How to initialize a new project?

Enter the script directory and run ./init-project.sh <new-project-name> to initialize a new project.

How to build?

• Install Rust, Cargo, cargo-apk and wasm-pack
• Install Android sdk, ndk, jdk17, and set environment variables.
• Example:

    export JAVA_HOME=$LIBRARY_PATH/openjdk
    export ANDROID_HOME=$HOME/Android/Sdk
    export ANDROID_NDK=$HOME/Android/Sdk/ndk/27.0.12077973
    export ANDROID_NDK_ROOT=$HOME/Android/Sdk/ndk/27.0.12077973

• Run make android-build-release to build a release version android APK
• Run make desktop-debug to run it on desktop platform
• Run make desktop-build-release to build a release version desktop application
• Run make web-build-dist to build a release version website. And the output directory is web/dist
• Run make web-server-dist to run a website server
• Refer to Makefile for more information

Android platform build information

• min-sdk-version = 23
• target-sdk-version = 32

Troubleshooting

• Using the Qt backend can resolve the issue of fuzzy fonts on the Windows platform. It is also recommended to prioritize the Qt backend to maintain a consistent build environment with the developers.

Reference

• Slint Language Documentation
• slint::android
• Running In A Browser Using WebAssembly
• github/slint-ui
• Viewer for Slint
• LSP (Language Server Protocol) Server for Slint
• developer.android.com
• How to Deploy Rust Binaries with GitHub Actions