From 9eb9a3e6217b708f308196e73fa2797ed4512dcd Mon Sep 17 00:00:00 2001 From: Mischa Spiegelmock Date: Sun, 9 Jul 2017 08:34:07 -0700 Subject: [PATCH] readme sample usage info --- README.md | 8 ++++++++ src/libprojectM/presets | 1 - 2 files changed, 8 insertions(+), 1 deletion(-) delete mode 120000 src/libprojectM/presets diff --git a/README.md b/README.md index 3522d31de..ea8989c4e 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,14 @@ Review the options and change what you think is necessary. Press 'g' to generate *** +# Using the library +At its core projectM is a library, [libprojectM](blob/master/src/libprojectM). This library is responsible for parsing presets, analyzing audio PCM data with beat detection and FFT, applying the preset to the audio feature data and rendering the resulting output with openGL. It can render to an openGL context or a texture. + +For an example of a very simple example use of the library see the [libSDL2 sample code](blob/master/src/projectM-sdl/projectM_SDL_main.cpp). +There are many other applications that make use of libprojectM that can be found in the [src](blob/master/src/) directory. + +*** + ## Help Report issues on [GitHub](https://github.com/projectM-visualizer/projectm/issues/new) diff --git a/src/libprojectM/presets b/src/libprojectM/presets deleted file mode 120000 index 171e84be4..000000000 --- a/src/libprojectM/presets +++ /dev/null @@ -1 +0,0 @@ -../../presets_projectM/ \ No newline at end of file