From bb08930e5569f83da203008d2c7e226819121c05 Mon Sep 17 00:00:00 2001 From: Edoardo Borgia Leiva Date: Wed, 18 Dec 2024 13:11:15 +0100 Subject: [PATCH] Created README.md Added: - Introduction section - Contributor section - Building section --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..fe6beb4 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +# GodoLauncher +![GitHub Repo stars](https://img.shields.io/github/stars/Edoardo-B-Leiva/godo-launcher?style=for-the-badge&label=GitHub%20stars) +![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/Edoardo-B-Leiva/godo-launcher/total?style=for-the-badge&label=Downloads) + +A simple Fortnite launcher for Windows made in Rust. + +## Contributors +- @G4-Synix +## Getting the launcher +Currently GodoLauncher is *only obtainable via building the source code* using cargo. +Other methods will be implemented in the near future alongside its development. +### Building from source +#### Requirements +- [Cargo](https://rustup.rs/) +#### Dependencies +- [reqwest](https://github.com/seanmonstar/reqwest) +- [serde](https://serde.rs/) +- [colog](https://github.com/chrivers/rust-colog) +#### Procedure +```powershell +git clone https://github.com/Edoardo-B-Leiva/godo-launcher --depth 1 && +cd godo-launcher && +cargo build --release +```