From 300c97d9118df2a2a8ab72c4dea7be45c6d04633 Mon Sep 17 00:00:00 2001 From: Lauchmelder Date: Sun, 26 Dec 2021 02:02:39 +0100 Subject: [PATCH] update readme --- README.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d13cac0..68debe9 100644 --- a/README.md +++ b/README.md @@ -5,12 +5,19 @@ Hopefully eventually a neat little realtime 3D audio visualizer. DSP is hard. ## How to build -Initialize and update the submodule `vendor/imgui`. -If you don't have GLFW and GLM installed on your machine (e.g. because you're on windows or because you can't be bothered), initialize and update `vendor/glfw` and `vendor/glm` as well to build from source. - -After that perform the following commands to generate build files +After cloning, perform the following commands ``` +git submodule update --init --recursive + mkdir build cd build cmake .. -``` \ No newline at end of file +``` + +Finally, to build the project do the following + +## Linux +Run `make` + +## Windows +CMake generated project files in the `build` directory which you can open in an IDE and build there. \ No newline at end of file