Skip to content

Commit a5f1372

Browse files
Update documentation before 1.0 release
1 parent 894380a commit a5f1372

File tree

10 files changed

+664
-218
lines changed

10 files changed

+664
-218
lines changed

Documentation/Compiling.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Compiling
2+
3+
This document details the process to compile OpenRGB from source on supported operating systems.
4+
5+
## Windows
6+
7+
* You will need the **Microsoft Visual 2019 C++ runtime** installed. You can get it [here](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
8+
* To build the application yourself on Windows:
9+
1. Download the latest [Visual Studio Community Edition](https://visualstudio.microsoft.com/thank-you-for-downloading-visual-studio-for-cplusplus/?sku=Community) and [Qt Creator](https://www.qt.io/download-thank-you).
10+
2. When [installing the QT toolset](https://gitlab.com/OpenRGBDevelopers/OpenRGB-Wiki/-/blob/stable/Downloading%20Qt%20and%20building%20OpenRGB.md) select the latest revision of Qt 5.15.x as OpenRGB is not yet compatible with QT6.
11+
3. Optionally [install Git](https://git-scm.com/download) if you intend to [contribute your changes](https://gitlab.com/CalcProgrammer1/OpenRGB/-/blob/master/CONTRIBUTING.md) to the mainline codebase.
12+
4. Open the OpenRGB.pro project in Qt Creator.
13+
5. Use the MSVC compiler kit, either 32- or 64-bit, to build the application.
14+
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.
15+
16+
## Linux
17+
18+
1. Install build dependencies
19+
- Debian/Ubuntu: `sudo apt install git build-essential qtcreator qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools libusb-1.0-0-dev libhidapi-dev pkgconf libmbedtls-dev qttools5-dev-tools`
20+
- Fedora: `sudo dnf install automake gcc-c++ git hidapi-devel libusbx-devel mbedtls-devel pkgconf qt5-qtbase-devel qt5-linguist`
21+
2. `git clone https://gitlab.com/CalcProgrammer1/OpenRGB`
22+
3. `cd OpenRGB`
23+
4. `mkdir build`
24+
5. `cd build`
25+
4. `qmake ../OpenRGB.pro`
26+
5. `make -j$(nproc)`
27+
6. You can then run the application from the compile directory with `./openrgb` or install with `make install`
28+
7. You will also need to [install the latest udev rules](UdevRules.md).
29+
30+
#### Packaging
31+
32+
You can also build OpenRGB generic AppImage packages and distribution-specific packages for Debian-based and Fedora-based distros. Install the build dependencies from the section above for your distribution before proceeding.
33+
34+
* AppImage:
35+
36+
* Debian/Ubuntu:
37+
* Make sure OpenRGB is cloned in ~/OpenRGB before proceeding. Output .deb is in ~/.
38+
1. `sudo apt install debhelper`
39+
2. `cd ~/OpenRGB`
40+
3. `scripts/build-package-files.sh debian/changelog`
41+
4. `dpkg-buildpackage -us -B`
42+
43+
* Fedora:
44+
* Make sure OpenRGB is cloned in ~/OpenRGB before proceeding. Output .rpm is in ~/rpmbuild/RPMS/.
45+
1. `sudo dnf install rpmdevtools dnf-plugins-core`
46+
2. `cd ~/`
47+
3. `rpmdev-setuptree`
48+
4. `tar -cf rpmbuild/SOURCES/OpenRGB.tar.gz OpenRGB/`
49+
4. `cd OpenRGB`
50+
5. `./scripts/build-package-files.sh fedora/OpenRGB.spec`
51+
6. `cd ~/`
52+
7. `cp OpenRGB/fedora/OpenRGB.spec rpmbuild/SPECS/`
53+
8. `sudo dnf builddep rpmbuild/SPECS/OpenRGB.spec -y`
54+
9. `cd rpmbuild/SOURCES`
55+
10. `tar -xf OpenRGB.tar.gz`
56+
11. `cd ~/`
57+
12. `rpmbuild -ba rpmbuild/SPECS/OpenRGB.spec`
58+
59+
## MacOS
60+
61+
1. Install build dependencies with Homebrew
62+
- Install Homebrew by following the instructions at https://brew.sh/
63+
- `brew install git qt5 hidapi libusb mbedtls@2`
64+
- `brew link qt5`
65+
2. [Create a local certificate](https://support.apple.com/guide/keychain-access/create-self-signed-certificates-kyca8916/mac) called OpenRGB with code signing capability
66+
3. git clone https://gitlab.com/CalcProgrammer1/OpenRGB
67+
4. cd OpenRGB
68+
5. qmake OpenRGB.pro
69+
6. make -j8
70+
7. macdeployqt OpenRGB.app -codesign=OpenRGB
71+
8. Copy the OpenRGB.app application package to Applications

Documentation/Images/OpenRGB.png

23.1 KB
Loading
59.2 KB
Loading

Documentation/KernelParameters.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Kernel Parameters
2+
3+
* To resolve an ACPI conflict add the `acpi_enforce_resources=lax` kernel parameter.
4+
* If you want to check if the kernel was loaded with this option you can execute this command from the terminal once you've rebooted: `cat /proc/cmdline`.
5+
6+
### Arch Linux
7+
8+
* Please see [the Arch wiki](https://wiki.archlinux.org/title/kernel_parameters) for details on how to update your bootloader.
9+
10+
### Debian/Ubuntu
11+
12+
* Please see [the Ubuntu Documentation](https://wiki.ubuntu.com/Kernel/KernelBootParameters) for Kernel Parameters for more information on updating your boot parameters.
13+
14+
### Fedora
15+
16+
* On Fedora, install `grubby` and then following command: `grubby --update-kernel=ALL --args="acpi_enforce_resources=lax"`.
17+
* For more information please refer to the Fedora docs for [grubby](https://docs.fedoraproject.org/en-US/fedora/latest/system-administrators-guide/kernel-module-driver-configuration/Working_with_the_GRUB_2_Boot_Loader/#sec-Making_Persistent_Changes_to_a_GRUB_2_Menu_Using_the_grubby_Tool).

0 commit comments

Comments
 (0)