10
10
11
11
<br />
12
12
13
- <h3 align =" center " >Frontend-SDL2-Rust </h3 >
13
+ <h3 align =" center " >ProjectM </h3 >
14
14
15
15
<p align =" center " >
16
- Example rust app , utilizing the <a href="https://crates.io/crates/projectm-rs " target="_blank">projectM</a> crate
16
+ Reference projectM application in Rust , utilizing the <a href="https://crates.io/crates/projectm" target="_blank">projectM</a> crate
17
17
<br />
18
18
<br />
19
- <a href="https://github.com/projectM-visualizer/frontend-sdl2 -rust/issues" target="_blank">Report Bug</a>
19
+ <a href="https://github.com/projectM-visualizer/frontend-sdl -rust/issues" target="_blank">Report Bug</a>
20
20
·
21
- <a href="https://github.com/projectM-visualizer/frontend-sdl2 -rust/issues" target="_blank">Request Feature</a>
21
+ <a href="https://github.com/projectM-visualizer/frontend-sdl -rust/issues" target="_blank">Request Feature</a>
22
22
</p >
23
23
</div >
24
24
45
45
<br />
46
46
47
47
<!-- GETTING STARTED -->
48
+
48
49
## Getting Started
49
50
50
51
To get this crate up and running properly, you'll need to install some prerequisites.
@@ -56,29 +57,29 @@ development files. To build projectM, both binaries and development files need t
56
57
57
58
#### General build dependencies for all platforms:
58
59
59
- * [ ** Rust** ] ( https://www.rust-lang.org/tools/install )
60
- * A working build toolchain.
61
- * [ ** CMake** ] ( https://cmake.org/ ) : Used to generate platform-specific build files.
62
- * ** OpenGL** : 3D graphics library. Used to render the visualizations.
63
- * or ** GLES3** : OpenGL libraries for embedded systems, version 3. Required to build projectM on Android devices,
60
+ - [ ** Rust** ] ( https://www.rust-lang.org/tools/install )
61
+ - A working build toolchain.
62
+ - [ ** CMake** ] ( https://cmake.org/ ) : Used to generate platform-specific build files.
63
+ - ** OpenGL** : 3D graphics library. Used to render the visualizations.
64
+ - or ** GLES3** : OpenGL libraries for embedded systems, version 3. Required to build projectM on Android devices,
64
65
Raspberry Pi, Emscripten and the Universal Windows Platform.
65
- * [ ** glm** ] ( https://github.com/g-truc/glm ) : OpenGL Mathematics library. Optional, will use a bundled version with
66
+ - [ ** glm** ] ( https://github.com/g-truc/glm ) : OpenGL Mathematics library. Optional, will use a bundled version with
66
67
autotools or if not installed.
67
- * [ ** SDL2 ** ] ( https://github.com/libsdl-org/SDL ) : Simple Directmedia Layer. Version 2.0.5 or higher is required to build
68
+ - [ ** SDL3 ** ] ( https://github.com/libsdl-org/SDL ) : Simple Directmedia Layer >= 3. Provided by sdl3-rs.
68
69
the test UI.
69
- * [ ** LLVM** ] ( https://llvm.org/ ) : Low-Level Virtual Machine. Optional and ** experimental** , used to speed up preset
70
+ - [ ** LLVM** ] ( https://llvm.org/ ) : Low-Level Virtual Machine. Optional and ** experimental** , used to speed up preset
70
71
execution by leveraging the LLVM JIT compiler.
71
72
72
73
#### Only relevant for Windows:
73
74
74
- * [ ** vcpkg** ] ( https://github.com/microsoft/vcpkg ) : C++ Library Manager for Windows. _ Optional_ , but recommended to
75
+ - [ ** vcpkg** ] ( https://github.com/microsoft/vcpkg ) : C++ Library Manager for Windows. _ Optional_ , but recommended to
75
76
install the aforementioned library dependencies.
76
- * [ ** GLEW** ] ( http://glew.sourceforge.net/ ) : The OpenGL Extension Wrangler Library. Only required if using CMake to
77
- configure the build, the pre-created solutions use a bundled copy of GLEW.
77
+ - [ ** GLEW** ] ( http://glew.sourceforge.net/ ) : The OpenGL Extension Wrangler Library. Only required if using CMake to
78
+ configure the build, the pre-created solutions use a bundled copy of GLEW.
78
79
<p align =" right " >(<a href =" #readme-top " >back to top</a >)</p >
79
80
80
-
81
81
<!-- USAGE EXAMPLES -->
82
+
82
83
## Usage
83
84
84
85
```
@@ -92,8 +93,8 @@ cargo build
92
93
### If using SDL installed via Homebrew
93
94
94
95
```
95
- RUSTFLAGS="-L$(brew --prefix sdl2 )/lib" cargo build
96
- RUSTFLAGS="-L$(brew --prefix sdl2 )/lib" cargo run
96
+ RUSTFLAGS="-L$(brew --prefix sdl3 )/lib" cargo build
97
+ RUSTFLAGS="-L$(brew --prefix sdl3 )/lib" cargo run
97
98
```
98
99
99
100
### Optimized build
@@ -104,9 +105,8 @@ cargo run --release
104
105
105
106
<p align =" right " >(<a href =" #readme-top " >back to top</a >)</p >
106
107
107
-
108
-
109
108
<!-- CONTRIBUTING -->
109
+
110
110
## Contributing
111
111
112
112
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are ** greatly appreciated** .
@@ -122,23 +122,24 @@ Don't forget to give the project a star! Thanks again!
122
122
123
123
<p align =" right " >(<a href =" #readme-top " >back to top</a >)</p >
124
124
125
-
126
-
127
125
<!-- LICENSE -->
126
+
128
127
## License
129
128
130
129
Distributed under the LGPL-2.1 license. See ` LICENSE ` for more information.
131
130
132
131
<p align =" right " >(<a href =" #readme-top " >back to top</a >)</p >
133
132
134
133
<!-- SUPPORT -->
134
+
135
135
## Support
136
136
137
137
[ ![ Discord] [ discord-shield ]] [ discord-url ]
138
138
139
139
<p align =" right " >(<a href =" #readme-top " >back to top</a >)</p >
140
140
141
141
<!-- CONTACT -->
142
+
142
143
## Contact
143
144
144
145
Blaquewithaq (Discord:
SoFloppy #1289 ) -
[ @anomievision ] ( https://twitter.com/anomievision ) -
[email protected]
@@ -147,16 +148,17 @@ Blaquewithaq (Discord: SoFloppy#1289) - [@anomievision](https://twitter.com/anom
147
148
148
149
<!-- MARKDOWN LINKS & IMAGES -->
149
150
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
151
+
150
152
[ contributors-shield ] : https://img.shields.io/github/contributors/projectM-visualizer/projectm-rs.svg?style=for-the-badge
151
- [ contributors-url ] : https://github.com/projectM-visualizer/frontend-sdl2 -rust/graphs/contributors
153
+ [ contributors-url ] : https://github.com/projectM-visualizer/frontend-sdl -rust/graphs/contributors
152
154
[ forks-shield ] : https://img.shields.io/github/forks/projectM-visualizer/projectm-rs.svg?style=for-the-badge
153
- [ forks-url ] : https://github.com/projectM-visualizer/frontend-sdl2 -rust/network/members
155
+ [ forks-url ] : https://github.com/projectM-visualizer/frontend-sdl -rust/network/members
154
156
[ stars-shield ] : https://img.shields.io/github/stars/projectM-visualizer/projectm-rs.svg?style=for-the-badge
155
- [ stars-url ] : https://github.com/projectM-visualizer/frontend-sdl2 -rust/stargazers
157
+ [ stars-url ] : https://github.com/projectM-visualizer/frontend-sdl -rust/stargazers
156
158
[ issues-shield ] : https://img.shields.io/github/issues/projectM-visualizer/projectm-rs.svg?style=for-the-badge
157
- [ issues-url ] : https://github.com/projectM-visualizer/frontend-sdl2 -rust/issues
159
+ [ issues-url ] : https://github.com/projectM-visualizer/frontend-sdl -rust/issues
158
160
[ license-shield ] : https://img.shields.io/github/license/projectM-visualizer/projectm-rs.svg?style=for-the-badge
159
- [ license-url ] : https://github.com/projectM-visualizer/frontend-sdl2 -rust/blob/master/LICENSE
161
+ [ license-url ] : https://github.com/projectM-visualizer/frontend-sdl -rust/blob/master/LICENSE
160
162
[ crates-shield ] : https://img.shields.io/crates/v/projectm-rs?style=for-the-badge
161
163
[ crates-url ] : https://crates.io/crates/projectm-rs
162
164
[ crates-dl-shield ] : https://img.shields.io/crates/d/projectm-rs?style=for-the-badge
0 commit comments