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.

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

Add Run/Install instructions + AUR Package #149

Closed
wants to merge 1 commit into from
Closed

Add Run/Install instructions + AUR Package #149

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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@ This tool allows you to set keys, macros, and lighting for GK6X keyboards (GK64,

It runs on Windows, Mac, and Linux.

## Run/Install

[:tada: :tada: Download releases here :tada: :tada:](https://github.com/pixeltris/GK6X/releases)

### Run with Mono

- Install Mono Runtime
- Download & Extract from releases & Run `mono GK6X.exe </gui | /f | /dumpkeys>`
- Read [this](README-CommandlineParameters.md) for Command Line Parameters & [Usage](#usage) for detailed information

### Install on Arch Linux

GK6X is available in [AUR](https://wiki.archlinux.org/title/Arch_User_Repository) as package [gk6x-bin](https://aur.archlinux.org/packages/gk6x-bin/) maintained by [@aakashhemadri](https://github.com/aakashhemadri)

## Usage

_Note: This is a CLI program, but see below for GUI. It's advisable to use the official software if you're on Windows / Mac._
Expand Down