KeyboardCraft

A desktop application aimed at generating optimal keyboard layouts.

Features

• Generation of optimal keyboard layouts
• Algorithm selection for optimal layout generation
• Keyboard management
• Character set management
• Profile management

Prerequisites

• Operating System: Linux or macOS.
• Java Version 11+: Ensure Java version 11 or higher is installed.
  • For macOS:
    Install Java version 11 using Homebrew:

    sudo brew install java11

    Follow the official Homebrew installation guide if needed: Homebrew Installation Guide
  • For Linux:
    Install Java version 11:

    sudo apt-get install openjdk-11-jdk

Installation

1. Clone the Repository:

   git clone [email protected]:jianingxu1/KeyboardCraft.git
   

Usage

1. Navigate to the Executable (EXE) Folder:

   cd EXE

2. Run the Application:

   ./gradlew run

3. Explore the application interface. For detailed instructions, refer to the User Manual

Contributing

If you'd like to contribute to the project, follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/fooBar).
3. Commit your changes (git commit -am 'Add some fooBar').
4. Push to the branch (git push origin feature/fooBar).
5. Create a new Pull Request.