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

Update README.md #1

Merged
merged 1 commit into from
Sep 24, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 22 additions & 10 deletions driver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,32 @@

A Kernel driver for Razer laptops with RGB keyboards

## How to use
## Installation

1. Install your linux headers

**If you have openrazer installed, you must remove it from your system.**
2. **If you have openrazer installed, you must remove it from your system:**
~~~bash
sudo apt remove openrazer-driver-dkms
~~~

### DKMS INSTALL INSTRUCTIONS
```
3. DKMS INSTALL INSTRUCTIONS

~~~bash
cd driver
sudo make driver_dkms
sudo dkms add -m razercontrol -v 1.3.0
sudo dkms build -m razercontrol -v 1.3.0
sudo dkms install -m razercontrol -v 1.3.0
```
After this, you MUST Rebuild your initramfs and reboot. The module will now be persistent
~~~
4. After this, you MUST Rebuild your initramfs and reboot:

### DKMS REMOVE INSTRUCTIONS
```
sudo dkms remove razercontrol -v 1.3.0 --all
```
~~~bash
sudo update-initramfs -u
sudo reboot
~~~

The module will now be persistent.

## Usage
**UPDATE: See the rgb_test_service folder for a easier way to use the system**
Expand Down Expand Up @@ -86,3 +93,8 @@ Creator (2)
```

NOTE: Turning on gaming mode can automatically make the fan increase in speed as the EC seems to switch to a more aggressive fan curve if still in automatic mode.

### DKMS REMOVE INSTRUCTIONS
```
sudo dkms remove razercontrol -v 1.3.0 --all
```