Update readme
This commit is contained in:
19
README.md
19
README.md
@@ -1,7 +1,20 @@
|
||||
# File-srv-gui-v3
|
||||
|
||||
[](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`
|
||||
|
||||
Reference in New Issue
Block a user