jordon/HarmonyLink
1
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages Wiki Activity Actions

Added Prerequisites section to the Getting Started.

Browse source 
Moved the existing content of the Getting Started to the compiling section.
This commit is contained in:
Jordon Brooks 2023-06-26 19:31:57 +01:00
parent 584ee679d0
commit 391e0365a6
1 changed files with 6 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

7
README.md
View file

@ -21,9 +21,14 @@ HarmonyLink operates using a client-server structure. This server-side applicati
Developers and modders can easily implement GET and POST requests from the API, integrating system metrics into games. These metrics can be used to adapt the game's quality settings, providing a more customized gaming experience.
## Getting Started
### Prerequisites
Before getting started, make sure you have:
This project assumes that you already know how to compile and run Rust applications.
- A working installation of [Rust](https://www.rust-lang.org).
- Familiarity with Rust syntax and concepts.
- [Git](https://git-scm.com/downloads) installed on your system.
### Compiling
1. Clone the repository: `git clone https://github.com/Jordonbc/HarmonyLinkServer.git`
2. Navigate into the directory: `cd HarmonyLinkServer`
3. Build the project: `cargo build`