Skip to content

Commit c16edd5

Browse files
committed
maintainer notes
1 parent 56a4677 commit c16edd5

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,10 +87,19 @@ There are many other applications that make use of libprojectM that can be found
8787
Report issues on [GitHub](https://github.com/projectM-visualizer/projectm/issues/new)
8888
We're on IRC at irc.freenode.net #projectM
8989

90+
If you would like to help improve this project, either with documentation, code, porting, hardware or anything else please let us know! We gladly accept pull requests and issues.
91+
92+
## Maintainers
93+
If you maintain packages of libprojectM, we are happy to work with you! Please note well:
94+
* The main focus of this project is libprojectM. It's a library that only really depends on OpenGL. The other applications are more like examples and demos.
95+
* This project was converted to use GNU autotools instead of CMake in 2018. This was due to inflexibility of CMake, issues with OSX and SDL2, an unintuitive configuration interface, standardizing on the most common and well-understood build system, a desire to make it easier for others to get up and running and contribute, and other factors too lengthy to expound on here.
96+
* Most of the applications (e.g. `src/projectM-*`) are likely outdated and of less utility than the core library. If you desire to use them or depend on them, please file an issue so we can help update them.
97+
* The "canonical" application for actually viewing the visualizations is now projectM-sdl, based on libSDL2 because it supports audio input and is completely cross-platform.
98+
* This is an open source project! If you don't like something, feel free to contribute improvements!
99+
* Yes, you are looking at the official version. This is not a fork.
100+
90101
## Authors
91102
[Authors](https://github.com/projectM-visualizer/projectm/raw/master/AUTHORS.txt)
92103

93-
If you would like to help improve this project, either with documentation, code, porting, hardware or anything else please let us know! We gladly accept pull requests and issues.
94-
95104
## License
96105
[LGPL](https://github.com/projectM-visualizer/projectm/raw/master/LICENSE.txt)

0 commit comments

Comments
 (0)