Created README.md

Added:
- Introduction section
- Contributor section
- Building section
This commit is contained in:
Marta Borgia Leiva 2024-12-18 13:11:15 +01:00
parent 6f003af531
commit bb08930e55

24
README.md Normal file
View file

@ -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
```