From b7b1c567d9add382c041bbe65d49face4de68c31 Mon Sep 17 00:00:00 2001 From: Piotr Siuszko Date: Sun, 25 Sep 2022 21:11:49 +0200 Subject: [PATCH] Add how to run info --- .github/workflows/rust.yml | 3 +++ README.md | 14 ++++++++++++++ 2 files changed, 17 insertions(+) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 08854a6..323db04 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -5,6 +5,9 @@ on: branches: [ main, master ] pull_request: branches: [ main, master ] + paths: + - 'egui_client/**' + - 'rusty_hub/**' env: CARGO_TERM_COLOR: always diff --git a/README.md b/README.md index 7467925..01d99c6 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,20 @@ Very simple alternative for Unity Hub. Rust pet project. ![rusty_hub_egui_MfuZVmPa9T](https://user-images.githubusercontent.com/13188195/192160570-44f98c74-8193-4027-b0e4-5b7b0d02157c.gif) +## Building and using + +[Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) is required in order to build it. + +Building is pretty simple, just copy repo, open `egui_client` subdirectory in `CLI` client and run these commands: + +```sh +git clone git@github.com:Leinnan/rusty_hub.git +cd rusty_hub/egui_client +cargo build --release +cargo run --release +``` + + ## Thanks Big thanks to https://github.com/unitycoder/UnityLauncherPro