Skip to content

Commit d282267

Browse files
Update README build section
1 parent f632365 commit d282267

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

README.md

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,33 @@ https://gitlab.com/CalcProgrammer1/OpenRGB
1212

1313
Development on this version has stalled as I'm not interested in supporting a multitude of proprietary SDKs that change constantly and only work on Windows. This version remains as Keyboard Visualizer 3.x and downloads are still available in the Release submodule. I will accept pull requests for this version if others wish to keep it alive, but I plan to focus primarily on the OpenRGB version (4.x) going forwards.
1414

15-
# Building
15+
# Download/Build
1616

17-
You must have the Microsoft Visual C++ 2015 32-bit redistributable package installed to run this program (Windows).
17+
## Windows
18+
* Pre-built binaries are available under the Releases section on GitLab.
1819

19-
To build this project in Linux, install QT Creator and libopenal-dev and open/build the .pro file.
20+
* If you wish to build the application yourself:
21+
22+
1. Download the latest Visual Studio Community Edition and Qt Creator.
23+
2. git clone https://gitlab.com/CalcProgrammer1/KeyboardVisualizer
24+
3. git submodule update --init --recursive
25+
4. Open the KeyboardVisualizer.pro project in Qt Creator.
26+
5. Use the MSVC compiler kit, either 32- or 64-bit, to build the application.
27+
6. Run the project from Qt Creator. If you want to use your custom build standalone, download the latest matching Release package and replace the OpenRGB.exe in it with your new build.
28+
29+
## Linux
30+
* Pre-built binaries are not currently available for Linux
31+
32+
* You can build the project using Qt Creator or on the command line. The commands listed here work for Debian-based distros.
33+
34+
1. sudo apt install build-essential qtcreator qt5-default libopenal-dev
35+
2. git clone https://gitlab.com/CalcProgrammer1/KeyboardVisualizer
36+
3. git submodule update --init --recursive
37+
4. cd KeyboardVisualizer
38+
5. qmake OpenRGB.pro
39+
6. make -j8
40+
41+
* Run the application with ./KeyboardVisualizer
2042

2143
# Settings
2244

0 commit comments

Comments
 (0)