From ebc488fefb22ba3f502f9a7e9c0884fb10c89750 Mon Sep 17 00:00:00 2001 From: Aakash Hemadri Date: Thu, 3 Jun 2021 16:01:21 +0530 Subject: [PATCH] Add Run/Install Instructions Signed-off-by: Aakash Hemadri --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 348165b..2b92e99 100644 --- a/README.md +++ b/README.md @@ -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 ` +- 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._