From 7c58c8a5bc031c1126e2591be585dd6f1087fc49 Mon Sep 17 00:00:00 2001 From: Jordon Brooks <16258926+Jordonbc@users.noreply.github.com> Date: Mon, 26 Jun 2023 21:07:41 +0100 Subject: [PATCH] Updated Getting Started (markdown) --- Getting-Started.md | 56 +++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 50 insertions(+), 6 deletions(-) diff --git a/Getting-Started.md b/Getting-Started.md index cbcfbd3..96dadab 100644 --- a/Getting-Started.md +++ b/Getting-Started.md @@ -1,13 +1,57 @@ # Getting Started + +This guide will walk you through the steps to set up and compile HarmonyLinkServer on your system. + ## Prerequisites -Before getting started, make sure you have: + +Before getting started, make sure you have the following prerequisites: - 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` -4. Run the project: `cargo run` \ No newline at end of file +## Clone the Repository + +To begin, you need to clone the HarmonyLinkServer repository using Git. Open your terminal or command prompt and enter the following command: + +```plaintext +git clone https://github.com/Jordonbc/HarmonyLinkServer.git +``` +This will create a local copy of the repository on your machine. + +## Navigate to the Project Directory + +Once the repository is cloned, navigate to the project directory using the cd command: + +```plaintext +cd HarmonyLinkServer +``` +You should now be inside the HarmonyLinkServer project directory. + +## Build the Project + +To build the HarmonyLinkServer project, use the following command: + +```plaintext +cargo build +``` +This command will compile the project and download any necessary dependencies. If successful, you will see the build output in your terminal. + +## Run the Project + +To run the HarmonyLinkServer, execute the following command: + +```plaintext +cargo run +``` +This will start the server application, and you will see relevant logs and information in your terminal. + +Congratulations! You have successfully set up and compiled HarmonyLinkServer on your system. You can now proceed to interact with the API using the available endpoints. + +For more information on the API endpoints and their usage, refer to the Endpoints documentation. + +## Troubleshooting + +If you encounter any issues during the setup or compilation process, refer to the project's issue tracker on GitHub for known issues and possible solutions. You can also seek help from the project's community or open a new issue if needed. + +We hope this guide helps you get started with HarmonyLinkServer. Happy coding!