Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add main readme to the repository #7

Merged
merged 1 commit into from
Dec 23, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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 .
```