lauchmelder/Visualizer
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

update readme

Browse source
This commit is contained in:
Lauchmelder 2021-12-26 02:02:39 +01:00
parent 0793884f42
commit 300c97d911
1 changed files with 12 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
README.md
View file

@ -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 ..
```
```
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.