# How to install ?

## How to Install R-Type Project

The R-Type project installation process varies slightly depending on your operating system. This guide covers installation for Windows, Linux, and macOS. Ensure you follow the steps for your specific platform.

**Common Steps for All Platforms**

1. **Clone the Repository:**  Begin by cloning the R-Type project repository from its source.
2. **Navigate to Scripts:** After cloning, navigate to the `scripts` directory within the project. This directory contains platform-specific scripts for setup and building.

## **Linux & macOS Installation** 🐧🍏 

**Run the Setup Script:**  

Execute the `setup.sh` script. This script will install necessary dependencies like Conan, CMake, and Doxygen. It will also handle necessary updates and installations for your specific Linux distribution or macOS.

```
./scripts/linux_macos/setup.sh
```

**Build the Project:** 

After setup, build the project by running the `build.sh` script. This compiles the project and creates the executables.

```
./scripts/linux_macos/build.sh
```

**Other Scripts:**

* Clean the build: `./scripts/linux_macos/clean.sh`
* Format the code: `./scripts/linux_macos/format.sh`

## **Windows Installation** 🪟

**Run the Setup Script:** 

First you need to install Vscode build tools at <https://visualstudio.microsoft.com/downloads/#remote-tools-for-visual-studio-2022>.

Before running the `setup.bat` script, ensure you're running the command prompt as an Administrator. This script will guide you through installing Python, Doxygen, LLVM (for Clang-Format), and Conan.

```
.\scripts\windows\setup.bat
```

**Build the Project:**&#x20;

Build the project by running the `build.bat` script. This will compile the project and create the executables.

```
.\scripts\windows\build.bat
```

**Other Scripts:**

* Clean the build: `.\scripts\windows\clean.bat`
* Format the code: `.\scripts\windows\format.bat`


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://r-type-5.gitbook.io/r-type/setup-guidelines/how-to-install.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.