How rosmord/mac_transliteration_keyboards works
Project type and purpose
• The README explains installation steps and usage; the code files themselves are static keyboard definitions (“.keylayout” + “.icns”) organized by layout (US, French) and by encoding (leyden vs legacy).
File structure
• Top level:
– Mac/
· egtrl-*-leyden.keylayout & .icns (the current recommended keyboards)
· legacy/ (old/non-leyden keyboards)
– pictures/ (screenshots illustrating installation)
– README.md, LICENSE, .gitignore
• No “src” or “backend” code—this is purely a packaging/distribution repository.
Key insights from README
• Describes usage of Ukulele to create keyboards (external tool)
• Details installation path (~/Library/Keyboard Layouts) and activation via System Preferences
• Distinguishes recommended “leyden” keyboards vs legacy versions
a. Main components
1. Repository (Git)
– pictures/ (installation docs)
– README.md (instructions)
2. External Tool: Ukulele (used to author keyboards)
3. User Installation Environment
– Installation folder: ~/Library/Keyboard Layouts
– macOS Keyboard System Preferences
4. Consumer Applications (Text editors, word processors)
b. Relationships and interactions
• Developer/Contributor uses Ukulele → generates or updates .keylayout + .icns → commits to Repository
• End-user clones/downloads Repository → copies selected .keylayout/.icns into ~/Library/Keyboard Layouts → opens System Preferences → enables custom keyboards → uses in any text app
c. Architectural patterns/principles
• Separation of concerns:
– Asset definitions (Mac/) vs Documentation (README + pictures/)
– Current vs legacy encodings clearly separated
• Conventional macOS installation path
d. Key technologies/frameworks
• Ukulele (keyboard creation)
• macOS Keyboard subsystem
• Unicode (transliteration standard)