[README][dev] improved README, adjusted scripts

This commit is contained in:
2025-03-20 19:38:00 +01:00
parent fda97f53be
commit b8bedbdfab
4 changed files with 8 additions and 44 deletions

View File

@ -10,16 +10,7 @@ Simple server and GUI for LAN parties.
### Prerequisites
```bash
# install Tauri CLI
cargo install tauri-cli --version "^2.0.0"
# install trunk (Build, bundle & ship your Rust WASM application to the web)
cargo install trunk
# alternatively if you have problems (i.e. on Windows)
cargo install cargo-binstall
cargo binstall trunk
# install Rust WASM target
rustup target add wasm32-unknown-unknown
cargo install tauri-cli
```
### Build
@ -28,14 +19,20 @@ rustup target add wasm32-unknown-unknown
# Development
cargo tauri dev # prefix with RUST_LOG=your_module=debug or similary for more verbose output
# Production but for testing and without bundling
cargo tauri build --no-bundle
# Production
cargo tauri build --profile release-lto # also bundles everything into a nice platform-specific installer
# on wayland you probably need to set this env var
WEBKIT_DISABLE_DMABUF_RENDERER=1
```
#### Backend
```bash
# Development
./server.sh # prefix with RUST_LOG=your_module=debug or similary for more verbose output
./server.sh [options...] # prefix with RUST_LOG=your_module=debug or similary for more verbose output
# Production
cargo build --profile release-lto