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.

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

feat(karabiner): add initial Karabiner-Elements configuration with custom rules #15

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

thomasvincent
Copy link
Owner

Issue Title: feat(karabiner): add initial Karabiner-Elements configuration with custom rules

Labels: setup, configuration, feature

Description:

  • Problem/Goal:

    • Problem: The current repository lacks a standardized keyboard customization setup, which can lead to inconsistent key mappings and reduced productivity.
    • Goal: Introduce a Karabiner-Elements configuration to standardize and enhance keyboard customizations across all development environments. This will include basic remappings, complex modifications, and automation scripts for installation and updates.
    • Why: Consistent and optimized key mappings can significantly improve workflow efficiency and user experience.
    • How: By creating a well-organized Karabiner-Elements configuration, including custom rules and automation scripts, we can ensure that all team members have access to the same keyboard customizations.
  • Relevant Systems:

    • OSes: macOS
    • Tools: Karabiner-Elements
  • Impact:

    • This will enable the project/team to have a consistent and efficient keyboard setup, improving productivity and reducing the time spent on manual key remappings. It will also make it easier to onboard new team members by providing a standardized configuration.

Acceptance Criteria:

    • Create a karabiner.json file with basic settings and custom rules.
    • Add complex modifications in separate JSON files within the complex_modifications directory.
    • Create an install.sh script to automate the installation of the Karabiner configuration.
    • Create an update.sh script to automate the updating of the Karabiner configuration.
    • Update the README.md file with instructions for setting up and using the Karabiner configuration.

Related Issues/PRs: N/A

Branch Name Suggestion: feature/karabiner-config

Additional Notes:

  • Ensure that the Karabiner-Elements application is installed and properly configured on all macOS systems.
  • Test the configuration on different macOS versions to ensure compatibility.
  • Consider adding more language-specific configurations as needed in the future.
  • Refer to the [Karabiner-Elements documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant