Skip to content

README: Added compilation & installation #1

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.

Sign up for GitHub

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

Open
Denperidge wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README: Added compilation & installation #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,21 @@ sudo dnf install cargo systemd-devel libevdev libevdev-devel

This is tested with a Wii MotionPlus Wiimote, and a Guitar Hero World Tour guitar. It should work with the other Guitar Hero Wii guitars (which have a slot for a Wiimote), and other Wiimotes, as long as both are recognised by the Linux kernel, though they have not been tested.

## Compiling / installing
```bash
# Download source & extract
wget https://github.com/ticky/roadii/archive/refs/heads/main.tar.gz -O roadii-main.tar.gz
tar -xzf roadii-main.tar.gz

# Enter directory & compile
cd roadii-main
cargo build --release

# Install roadii to /home/deck/bin
sudo install -m 755 -t /home/deck/bin target/release/roadii
# The previous line can probably be replaced with chmod && cp if need be
```

## Setup

Provided in the `etc` folder are an example udev rule and systemd service to automatically run Roadii when a supported Wii guitar controller is connected. This presumes you are using SteamOS, adapting to other Linux systems is left as an exercise for the reader.
Expand Down