Giter VIP home page Giter VIP logo

youngboy1229 / karabiner-elements Goto Github PK

View Code? Open in Web Editor NEW

This project forked from pqrs-org/karabiner-elements

0.0 0.0 0.0 70.88 MB

Karabiner-Elements is a powerful utility for keyboard customization on macOS Sierra (10.12) or later.

Home Page: https://pqrs.org/osx/karabiner/

License: The Unlicense

Makefile 0.74% Shell 0.94% Ruby 0.03% C++ 79.01% Objective-C 15.92% AppleScript 0.11% C 1.47% CMake 1.79%

karabiner-elements's Introduction

Build Status License

Karabiner-Elements

Karabiner-Elements is a powerful utility for keyboard customization on macOS Sierra or later.

Download

You can download Karabiner-Elements from official site.

Old releases

You can download previous versions of Karabiner-Elements from here.

Supported systems

  • macOS Sierra (10.12)
  • macOS High Sierra (10.13)
  • macOS Mojave (10.14)
  • macOS Catalina (10.15)

Usage

https://pqrs.org/osx/karabiner/document.html

Donations

If you would like to contribute financially to the development of Karabiner Elements, donations can be made via https://pqrs.org/osx/karabiner/pricing.html


For developers

How to build

System requirements to build Karabiner-Elements:

  • macOS 10.14+
  • Xcode 10+
  • Command Line Tools for Xcode
  • CMake (brew install cmake)

Step 1: Getting source code

Clone the source from github.

git clone --depth 1 https://github.com/pqrs-org/Karabiner-Elements.git

Step 2: Building a package

cd Karabiner-Elements
make package

The make script will create a redistributable Karabiner-Elements-VERSION.dmg in the current directory.

Note: About pre-built binaries in the source tree

Karabiner-Elements uses some pre-built binaries in the source tree.

  • src/vendor/Karabiner-VirtualHIDDevice/dist/*.kext
  • src/vendor/Sparkle/Sparkle.framework

Above make package command does not rebuild these binaries.
(These binaries will be copied in the distributed package.)

If you want to rebuild these binaries, you have to build them manually.
Please follow the instruction of these projects.

About rebuilding kext in Karabiner-VirtualHIDDevice

If you want to build kext in Karabiner-VirtualHIDDevice, macOS requires a valid certificate which be able to sign the built kext.
Unless such certificate, macOS refuses to load the built kext.
Please read a documentation about System Integrity Protection Guide for more details.

(We are including the pre-built kext binary to avoid the restriction that macOS requires a uncommon certificate.)

karabiner-elements's People

Contributors

tekezo avatar josephmilla avatar talha131 avatar d3v1anx avatar carlsmith avatar hakubo avatar gaomd avatar ipetepete avatar saagarjha avatar samm-git avatar axet avatar benreyn avatar luxcium avatar cperryk avatar 0x6368 avatar dcato avatar francisteo avatar justinhaaheim avatar kozo2 avatar zlargon avatar mchowning avatar rolandwalker avatar sitaktif avatar rys avatar smlewis avatar wwwjfy avatar vsubhuman avatar vova avatar rcmdnk avatar ys64 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.