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

Documentation required #53

Open
r4dian opened this issue Aug 10, 2020 · 5 comments
Open

Documentation required #53

r4dian opened this issue Aug 10, 2020 · 5 comments

Comments

@r4dian
Copy link

r4dian commented Aug 10, 2020

Mac standalone version:

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

@kblaschke
Copy link
Member

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

@nova0052
Copy link

What is the current status on documentation?

@kblaschke
Copy link
Member

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
Copy link

nova0052 commented May 6, 2022

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
Copy link
Member

kblaschke commented Jun 25, 2022

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

@kblaschke kblaschke transferred this issue from projectM-visualizer/projectm Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants