search

projectM-visualizer / frontend-sdl2

Standalone application based on SDL2 that turns your desktop audio into awesome visuals. Available on most platforms supported by both libprojectM and libSDL2.
GNU General Public License v3.0
58 stars 32 forks source link

Documentation required #53

Open r4dian opened 3 years ago

r4dian commented 3 years ago

Mac standalone version:

Where should presets be copied to work with this? Obviously theres no Winamp folder to put them in..

kblaschke commented 2 years ago

Started adding content to the project Wiki. Will continue over the next days, adding both end-user, integration and core project developer documentation.

nova0052 commented 2 years ago

What is the current status on documentation?

kblaschke commented 2 years ago

Still a work in progress, as we've not finished the API for the 4.0 release.

If you could state what kind of documentation you're missing, we might be able to put up something you can use.

Remember the current code is changing a lot, so we don't recommend basing any production work on it yet. You can still play around with it and test it, but be aware that the API can still change at any time until the first release candidate is out.

nova0052 commented 2 years ago

I'm looking for basic build instructions that a regular Linux user could follow.

README.md directs Linux users to go to https://github.com/projectM-visualizer/frontend-sdl2/releases, which is empty, and that repo's readme is blank.

There is also an open issue on that repo asking for documentation, but it was opened months ago and no devs have responded.

kblaschke commented 2 years ago

The new SDL frontend is a full rewrite started earlier this year, and not yet finished. It has no install target for example and thus will only run from the build dir. I'll add proper build instructions once the app has matured enough to be used in production. Mischa recently added a short readme with basic build instructions.

Also note the library and frontends have been split up into separate repositories, so there will be spearate build instructions for each.

If you look for instructions on how to build libprojectM, the wiki already has the proper documentation: https://github.com/projectM-visualizer/projectm/wiki/Building-libprojectM