Update readme
All checks were successful
Build / Check (push) Successful in 23s
Build / Build (push) Successful in 3m20s

This commit is contained in:
2026-03-20 12:58:26 -04:00
parent 2dd6b5ad0a
commit 90cfd4012e
2 changed files with 17 additions and 4 deletions

View File

@@ -1,7 +1,20 @@
# File-srv-gui-v3
[![Build Status](https://cicd.catgirls.fish/job/file-srv-gui-v3/badge/icon)](https://cicd.catgirls.fish/job/file-srv-gui-v3/)
The third iteration of the Megascans repo GUI.
Compatible with [file-srv-v2](https://git.catgirls.fish/firewire/file-srv-v2) (Current iteration)
Linux and ~~Windows~~ (soon) builds are available via the releases page.
Linux and Windows builds are available via the releases page.
## Building
Make sure you have a valid rust toolchain, you can download and setup one with [rustup](https://rustup.rs/).
Build steps are the same on both windows and linux.
1. Clone the repo `git clone https://git.catgirls.fish/firewire/file-srv-gui-v3`
2. cd into the repo `cd file-srv-gui-v3`
3. Build the binary `cargo build --release`
*Notes:*
- You may need to restart your terminal after installing rust
- You can run the binary directly with `cargo run --release`