From 90cfd4012ed0574131df7e89b9702e85cc51d3f7 Mon Sep 17 00:00:00 2001 From: firewire Date: Fri, 20 Mar 2026 12:58:26 -0400 Subject: [PATCH] Update readme --- .gitea/workflows/build.yml | 2 +- README.md | 19 ++++++++++++++++--- 2 files changed, 17 insertions(+), 4 deletions(-) diff --git a/.gitea/workflows/build.yml b/.gitea/workflows/build.yml index 2456e56..341a2af 100644 --- a/.gitea/workflows/build.yml +++ b/.gitea/workflows/build.yml @@ -46,7 +46,7 @@ jobs: run: mv target/release/file-srv-gui-v3 file-srv-gui-v3-linux-amd64 && mv target/debug/file-srv-gui-v3 file-srv-gui-v3-linux-debug-amd64 - name: Renaming windows binaries - run: mv target/target/x86_64-pc-windows-gnu/release/file-srv-gui-v3.exe file-srv-gui-v3-win.exe && mv target/x86_64-pc-windows-gnu/debug/file-srv-gui-v3.exe file-srv-gui-v3-win-debug.exe + run: mv target/x86_64-pc-windows-gnu/release/file-srv-gui-v3.exe file-srv-gui-v3-win.exe && mv target/x86_64-pc-windows-gnu/debug/file-srv-gui-v3.exe file-srv-gui-v3-win-debug.exe - uses: akkuman/gitea-release-action@v1 with: diff --git a/README.md b/README.md index 047d80f..26125d7 100644 --- a/README.md +++ b/README.md @@ -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`