Readme.md 2.33 KB
Newer Older
Cyprien Plateau--Holleville's avatar
Cyprien Plateau--Holleville committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
<h1 align="center">Udock</h1>

![Logo](readme/Banner2.png) 

If you need help to use this software, please refer to the [__Guide__](Guide.md).

## Install

To clone the project and its dependencies:
```
  git clone --recurse-submodules -j8 https://gitlab.com/Udock/Udock2
```

The project is using CMake, to build it you may use the following command or your favorite IDE:
```
  cd Udock
  mkdir build && cd build
  cmake ..
  cmake --build . --target Udock --config Release
```

The project has been tested on Windows 10 (VS2019) and Linux (g++-9/11).

## Acknowledgement

The following resources have been used for the development of this project:

- [Cubemaps](https://learnopengl.com/Advanced-OpenGL/Cubemaps) and [Diffuse irradiance](https://learnopengl.com/PBR/IBL/Diffuse-irradiance) 
chapter of LearnOpengl [Joey de Vries](https://twitter.com/JoeyDeVriez) licensed under the terms of 
the [CC BY-NC 4.0 license](https://creativecommons.org/licenses/by-nc/4.0/).
- [Raptor Spaceship Low Poly](https://skfb.ly/osJ6J) by Noddity is licensed under the terms of the [CC BY 4.0 license](http://creativecommons.org/licenses/by/4.0/) and 
converted in OBJ with Blender.
- [Milky Way HDRI file](http://www.hdrlabs.com/sibl/archive.html) by HDRlabs is licensed under the terms of the [CC BY-NC-SA 3.0 license](https://creativecommons.org/licenses/by-nc-sa/3.0/) 
and converted in cubemap with [HDRI-to-CubeMap](https://matheowis.github.io/HDRI-to-CubeMap/) by Mateusz Wisniowski.

This project would also not have been made without the help of the following libraries:
- [Bullet Physics SDK](https://github.com/bulletphysics/bullet3)
- [Chemfiles: a library for reading and writing chemistry files](https://github.com/sacraiou/chemfiles)
- [entt](https://github.com/skypjack/entt)
- [fmt](https://github.com/fmtlib/fmt)
- [gl3w: Simple OpenGL core profile loading](https://github.com/skaslev/gl3w)
- [glm](https://github.com/g-truc/glm)
- [Guidelines Support Library (GSL)](https://github.com/microsoft/GSL)
- [Dear ImGui](https://github.com/ocornut/imgui)
- [Marching Cube C++](https://github.com/aparis69/MarchingCubeCpp)
- [Portable File Dialogs](https://github.com/samhocevar/portable-file-dialogs)
- [Simple DirectMedia Layer (SDL) Version 2.0](https://github.com/libsdl-org/SDL)
- [stb](https://github.com/nothings/stb)
- [tinyobjloader](https://github.com/tinyobjloader/tinyobjloader)