diff --git a/README.md b/README.md new file mode 100644 index 0000000..aa1ed1b --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +[![Build for Windows using MSVC](https://github.com/geissomatik/geiss/actions/workflows/windows-msvc.yml/badge.svg)](https://github.com/geissomatik/geiss/actions/workflows/windows-msvc.yml) + + +# Geiss Screensaver and Winamp plug-in + +This repository holds the latest code of the Geiss Screensaver and Winamp plug-in; +for general information about Geiss please see: + +- [At a glance: Geiss](https://www.geisswerks.com/about_geiss.html) +- [Official Homepage of the Geiss Screensaver and Winamp plug-in](https://www.geisswerks.com/geiss/) +- [Screenshots from Geiss](https://www.geisswerks.com/geiss/shots.html) +- [How 'Geiss' Worked](https://www.geisswerks.com/geiss/secrets.html) +- [Geiss @ WinampHeritage.com](https://winampheritage.com/visualizations/geiss) +- [Geisswerks — home page of Ryan M. Geiss](https://www.geisswerks.com/) + +For a YouTube video showing Geiss in action, please click: + +[![Video" Geiss visualization for Winamp/MediaMonkey/JetAudio" on YouTube](https://img.youtube.com/vi/pBCvhBcEpHQ/hqdefault.jpg)](https://www.youtube.com/watch?v=pBCvhBcEpHQ) + + +# Compiling locally + +In order to compile the Geiss Winamp plug-in and/or the Geiss Screensaver, +you need: + +- A Git clone or snapshort of this repository +- CMake >=3.15 +- Microsoft Visual Studio >=9/2008 (due to the current use of MSVC style assembly) + +Then, the code can be built using: + +```console +# cmake -G "Visual Studio 17 2022" -A Win32 -DCMAKE_BUILD_TYPE=RelWithDebInfo . +# cmake --build . +```