Update README.md
This commit is contained in:
parent
9c4b47f39c
commit
02883a4830
68
README.md
68
README.md
|
@ -12,38 +12,70 @@ TerraVisor is a 3D visualization tool designed for rendering and exploring terra
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
- **CMake**: Ensure CMake is installed on your system ([Download CMake](https://cmake.org/download/)).
|
Before building TerraVisor, ensure that you have the following prerequisites installed on your system:
|
||||||
- **GLEW and GLFW**: TerraVisor requires GLEW and GLFW for OpenGL context creation and management.
|
|
||||||
|
|
||||||
### Building from Source
|
- **Git**: Used for cloning the repository and managing source code.
|
||||||
|
- **CMake**: Build system generator used to configure the project.
|
||||||
|
- **Ninja**: Fast build system used to compile the project.
|
||||||
|
- **vcpkg**: Package manager for acquiring C++ libraries.
|
||||||
|
|
||||||
1. **Clone the Repository**:
|
### Installation Steps
|
||||||
|
|
||||||
|
1. **Clone the Repository**:
|
||||||
|
|
||||||
|
First, clone the repository from GitLab
|
||||||
```bash
|
```bash
|
||||||
git clone git@gitlab.yourserver.com:username/TerraVisor.git
|
git clone http://git.jackmchristensen.com/jack/terravisor.git
|
||||||
cd TerraVisor
|
cd terravisor
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Build the Project**
|
2. **Install vcpkg**:
|
||||||
|
|
||||||
|
If you haven’t installed `vcpkg` yet, follow these steps to set it up:
|
||||||
```bash
|
```bash
|
||||||
mkdir build && cd build
|
git clone https://github.com/microsoft/vcpkg.git
|
||||||
cmake -DCMAKE_BUILD_TYPE=Release ..
|
cd vcpkg
|
||||||
cmake --build .
|
./bootstrap-vcpkg.sh # Use .\bootstrap-vcpkg.bat on Windows
|
||||||
|
```
|
||||||
|
Optionally, integrate `vcpkg` with your system:
|
||||||
|
```bash
|
||||||
|
./vcpkg integrate install
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Run the Application:**
|
3. **Install Dependencies**: \
|
||||||
|
Use `vcpkg` to install dependencies:
|
||||||
|
```bash
|
||||||
|
./vcpkg install glm glew glfw3 assimp
|
||||||
|
```
|
||||||
|
|
||||||
Navigate to the build directory and run the executable:
|
4. **Configure the Project**:
|
||||||
```bash
|
|
||||||
./TerraVisor
|
Navigate back to the project root directory and configure the project using CMake and Ninja. Be sure to specify the `vcpkg` toolchain file:
|
||||||
|
```bash
|
||||||
|
cd ..
|
||||||
|
cmake -B build -S . -G Ninja -DCMAKE_TOOLCHAIN_FILE=./vcpkg/scripts/buildsystems/vcpkg.cmake
|
||||||
|
```
|
||||||
|
|
||||||
|
5. **Build the Project**:
|
||||||
|
|
||||||
|
Build the project using Ninja:
|
||||||
|
```bash
|
||||||
|
cmake --build build
|
||||||
|
```
|
||||||
|
|
||||||
|
6. **Run the Application**:
|
||||||
|
|
||||||
|
Once the build process is complete, you can run the TerraVisor application:
|
||||||
|
```bash
|
||||||
|
./build/TerraVisor
|
||||||
```
|
```
|
||||||
|
|
||||||
## Acknowledgements
|
## Acknowledgements
|
||||||
|
|
||||||
GLEW - OpenGL Extension Wrangler Library
|
GLEW - OpenGL Extension Wrangler Library \
|
||||||
GLFW - OpenGL Framework
|
GLFW - OpenGL Framework \
|
||||||
GLM - OpenGL Mathematics
|
GLM - OpenGL Mathematics \
|
||||||
ASSIMP - Open Asset Import Library
|
ASSIMP - Open Asset Import Library \
|
||||||
Dear ImGui
|
Dear ImGui
|
||||||
|
|
||||||
## Contact
|
## Contact
|
||||||
|
|
Loading…
Reference in New Issue