Skip to content

Commit

Permalink
Merge pull request #76 from jorijnsmit/master
Browse files Browse the repository at this point in the history
Tidying up README. Solves #41
  • Loading branch information
wroberts authored May 28, 2022
2 parents c7e94e8 + fe05524 commit 7831349
Showing 1 changed file with 24 additions and 15 deletions.
39 changes: 24 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Aura Core software. Supports RGB keyboards with IDs
[0b05:1854](https://linux-hardware.org/index.php?id=usb:0b05-1854)
(GL553, GL753),
[0b05:1869](https://linux-hardware.org/index.php?id=usb:0b05-1869)
(GL503, FX503, GL703), [0b05:1866](https://linux-hardware.org/index.php?id=usb:0b05-1866) (GL504, GL703, GX501, GM501), and [0b05:19b6](https://linux-hardware.org/index.php?id=usb:0b05-19b6) (GA503).
(GL503, FX503, GL703), [0b05:1866](https://linux-hardware.org/index.php?id=usb:0b05-1866) (GL504, GL533, GL703, GX501, GM501), and [0b05:19b6](https://linux-hardware.org/index.php?id=usb:0b05-19b6) (GA503).

## Usage

Expand Down Expand Up @@ -39,7 +39,7 @@ In typical use, you will need root privileges to directly communicate
with the laptop's keyboard. This is easy to do with `sudo`. Try some
of these commands and see what works for you:

```
```sh
sudo rogauracore single_static 0000ff
sudo rogauracore single_static 00ff00
sudo rogauracore single_static ffff00
Expand All @@ -50,39 +50,48 @@ sudo rogauracore single_colorcycle 1
If your keyboard does not respond to `rogauracore`, it may help to
send an initialisation message to the keyboard to "wake it up":

```
```sh
sudo rogauracore initialize_keyboard
```

If your keyboard remains dark, its brightness might have defaulted to 0. Try:

```
```sh
sudo rogauracore brightness 3
```

## Building
## Installation

### On Ubuntu from a release:
### Ubuntu

```
In all cases you will need `libusb` and `libusb-dev` installed:
```sh
sudo apt install libusb-1.0-0 libusb-1.0-0-dev
```
Optionally you might also need build tools:
```sh
sudo apt install build-essential
```

Retrieve the `rogauracore` package, either through `curl` or `git`:
```sh
VERSION=1.5
curl -LOs https://github.com/wroberts/rogauracore/releases/download/$VERSION/rogauracore-$VERSION.tar.gz
tar xf rogauracore-$VERSION.tar.gz
cd rogauracore-$VERSION/
./configure
make
sudo make install
```

### From github:

Clone the github repo and enter the top-level directory. Then:

or
```sh
git clone https://github.com/wroberts/rogauracore.git
cd rogauracore
autoreconf -i
```

Then configure, make and install:
```sh
./configure
make
sudo make install
```

## Tips and tricks
Expand Down

0 comments on commit 7831349

Please sign in to comment.