update readme

This commit is contained in:
Jarcode
2017-11-25 23:00:08 -08:00
parent ebfc4dd6df
commit 44ce4cf3eb

View File

@@ -1,8 +1,8 @@
# GLava
## GLava
GLava is an (in development) OpenGL audio spectrum visualizer. Its primary use case is for desktop widgets or backgrounds.
Compiling (after meeting the requirements):
**Compiling** (after meeting the requirements)**:**
```
git clone --recursive https://github.com/wacossusca34/glava
@@ -13,25 +13,28 @@ make
There are currently no make rules (or configure script) for installing anywhere else on the system, and the shaders are hardcoded to be read from the current directory. When development is complete, I will finish the configure & build process.
Requirements:
Note: GLFW's most recent stable version is 3.2, whereas this program needs 3.3 in order to support transparency. You can
either find a more recent build or compile it yourself. Arch users can install `glfw-x11-git` from the AUR.
**Requirements:**
- X11
- PulseAudio
- GLFW
- GLFW (version 3.3+ needed for transparency support)
- Linux or BSD
Additional compile time requirements:
**Additional compile time requirements:**
- glad (included as a submodule)
- python (required to generate bindings with glad)
- GCC (this program uses GNU C features)
What needs to be done:
**What needs to be done:**
- Fix breaks in audio spetrum read from the PulseAudio server (possibly a scheduling issue?)
- Fix breaks in audio spectrum read from the PulseAudio server (possibly a scheduling issue?)
- Fix OpenGL code from crashing the `nvidia` driver on Linux (???)
What is complete:
**What is complete:**
- Core renderer
- FFT algorithm
@@ -39,6 +42,6 @@ What is complete:
- Preprocessor directive parsing to handle requests and transformations on uniforms before they are passed to the shader.
- Detecting if the window manager reports the currently focused window as fullscreen (and halting rendering for the duration)
What will never be done:
**What will never be done:**
- Port to Windows (???)