README.md

Karabiner Complex Rules Generator

View Demo · Report Bug · Request Feature · Send a Pull Request

Table of Contents

• Table of Contents
• About The Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Roadmap
• Contributing
• License
• Contact
• Acknowledgements

About The Project

An open-source web app to help make and configure karabiner complex modification files!

Built With

• ReactJS
• Material UI

Getting Started

Prerequisites

• yarn

npm install yarn -g

Installation

1. Clone the project

git clone https://github.com/genesy/karabiner-complex-rules-generator.git

2. Install NPM packages

yarn install

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are extremely appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GNUv3 License. See LICENSE for more information.

Contact

Gene Sy - @GeneSy - gnsyftw@gmail.com

Project Link: https://github.com/genesy/karabiner-complex-rules-generator/

Acknowledgements

• Img Shields
• GitHub Pages
• Karabiner Elements