From 913024b4f16e94408d3db99860ddf793715a5945 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Th=C3=A9au?= <theau.baton@etu.univ-amu.fr>
Date: Sun, 2 Jun 2024 21:55:46 +0200
Subject: [PATCH] Add Reademe

---
 ParticleGenerator/CMakeLists.txt |  7 ++++++-
 README.md                        | 22 +++++++++++++++++++++-
 TODO.md                          |  0
 3 files changed, 27 insertions(+), 2 deletions(-)
 delete mode 100644 TODO.md

diff --git a/ParticleGenerator/CMakeLists.txt b/ParticleGenerator/CMakeLists.txt
index 113b5a7..27defbf 100644
--- a/ParticleGenerator/CMakeLists.txt
+++ b/ParticleGenerator/CMakeLists.txt
@@ -27,7 +27,12 @@ set(CMAKE_CXX_EXTENSIONS OFF)
 #=====================================
 
 option(USE_STATIC_DEPENDENCIES "Use dependencies as static libraries" OFF)
-option(CMAKE_TOOLCHAIN_FILE "C:/vcpkg/vcpkg/scripts/buildsystems/vcpkg.cmake")
+
+if(WIN32)
+	option(CMAKE_TOOLCHAIN_FILE "C:/vcpkg/scripts/buildsystems/vcpkg.cmake")
+elseif(UNIX)
+	option(CMAKE_TOOLCHAIN_FILE "/usr/local/share/vcpkg/scripts/buildsystems/vcpkg.cmake")	
+endif()
 
 #=====================================
 #				Macros
diff --git a/README.md b/README.md
index 59e1707..95920d4 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,23 @@
 # Curve Tools
 
-# Particle Generator
\ No newline at end of file
+Pour compiler `CuvreTools`, il suffit d'utiliser le CMake présent dans le dossier `CurveTools`.
+
+# Particle Generator
+
+Pour compiler le générateur de particules, il suffit d'utiliser le CMake présent dans le dossier `Particlegenerator`.
+Pour pouvoir compiler correctement il faut utiliser `VCPKG` : https://vcpkg.io/en/.
+
+Les bibliothèques à installer avec VPCKG son : 
+
+```
+vcpkg install assimp
+vcpkg install glew
+vcpkg install imgui[glfw-binding]
+vcpkg install imgui[opengl3-binding]
+vcpkg install opengl
+vcpkg install stb
+vcpkg install tinyfiledialogs
+```
+
+Il faut aussi ajouter une version de `CurveTools` au projet, dans le dossier `Particlegenerator/external/lib`.
+Il faut aussi copier le dossier `CurveTools/include/CurveTools`, dans `Particlegenerator/external/lib/include`.
diff --git a/TODO.md b/TODO.md
deleted file mode 100644
index e69de29..0000000
-- 
GitLab