add readme

.gitignore

@@ -1,5 +1,5 @@
-# Created by https://www.toptal.com/developers/gitignore/api/macos
-# Edit at https://www.toptal.com/developers/gitignore?templates=macos
+# Created by https://www.toptal.com/developers/gitignore/api/macos,swift
+# Edit at https://www.toptal.com/developers/gitignore?templates=macos,swift
 
 ### macOS ###
 # General
@@ -34,4 +34,88 @@ Temporary Items
 # iCloud generated files
 *.icloud
 
-# End of https://www.toptal.com/developers/gitignore/api/macos
+### Swift ###
+# Xcode
+#
+# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
+
+## User settings
+xcuserdata/
+
+## compatibility with Xcode 8 and earlier (ignoring not required starting Xcode 9)
+*.xcscmblueprint
+*.xccheckout
+
+## compatibility with Xcode 3 and earlier (ignoring not required starting Xcode 4)
+build/
+DerivedData/
+*.moved-aside
+*.pbxuser
+!default.pbxuser
+*.mode1v3
+!default.mode1v3
+*.mode2v3
+!default.mode2v3
+*.perspectivev3
+!default.perspectivev3
+
+## Obj-C/Swift specific
+*.hmap
+
+## App packaging
+*.ipa
+*.dSYM.zip
+*.dSYM
+
+## Playgrounds
+timeline.xctimeline
+playground.xcworkspace
+
+# Swift Package Manager
+# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
+# Packages/
+# Package.pins
+# Package.resolved
+# *.xcodeproj
+# Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata
+# hence it is not needed unless you have added a package configuration file to your project
+# .swiftpm
+
+.build/
+
+# CocoaPods
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+# Pods/
+# Add this line if you want to avoid checking in source code from the Xcode workspace
+# *.xcworkspace
+
+# Carthage
+# Add this line if you want to avoid checking in source code from Carthage dependencies.
+# Carthage/Checkouts
+
+Carthage/Build/
+
+# Accio dependency management
+Dependencies/
+.accio/
+
+# fastlane
+# It is recommended to not store the screenshots in the git repo.
+# Instead, use fastlane to re-generate the screenshots whenever they are needed.
+# For more information about the recommended setup visit:
+# https://docs.fastlane.tools/best-practices/source-control/#source-control
+
+fastlane/report.xml
+fastlane/Preview.html
+fastlane/screenshots/**/*.png
+fastlane/test_output
+
+# Code Injection
+# After new code Injection tools there's a generated folder /iOSInjectionProject
+# https://github.com/johnno1962/injectionforxcode
+
+iOSInjectionProject/
+
+# End of https://www.toptal.com/developers/gitignore/api/macos,swift

README.md

@@ -0,0 +1,54 @@
+# Jugoslavica
+
+Keyboard Layout Simplifying Slavic Latin Diacritics Input
+
+## Why Not Stick with the Default Layout?
+
+Let's break it down. The standard layout doesn't quite match up with the
+familiar Latin QWERTY we're used to. There's a bit of a learning curve, and
+those extra characters **(Č, Ć, Đ, Š, Ž)** overlap the
+punctuation keys. It becomes especially frustrating if you find yourself
+typing more often in English than in Serbo-Croatian. This can pose a significant
+headache for programmers.
+
+## What's the Solution?
+
+This layout offers the option to conveniently access accent characters by
+utilizing a separate input level, accessible through the `⌥ Opt` key. So, this
+not only facilitates typing in Serbo-Croatian but also caters to the broader
+range of the Slavic Latin alphabet.
+
+## What's Included?
+
+* For Serbo-Croatian and Slovenian: **Č (Ч), Ć (Ћ), Đ (Ђ), Š (Ш), Ž (Ж)**
+
+* Montenegrin extras: **Ś** and **Ź**
+
+* Macedonian: **Č (Ч), Ǵ (Ѓ), Ḱ (Ќ), Š (Ш), Ž (Ж)**
+
+* [Bulgarian][1]: **Ă (Ъ)**
+
+* Old Church Slavonic: **Ě (Ѣ), Ĭ (Ь), Ŭ (Ъ), ϴ (Ѳ), Ÿ (Ѷ)**
+
+* [Belarusian][2]: **Č (Ч), Š (Ш), Ž (Ж), Ć (Ць), Ś (Сь), Ź (Зь), Ń (Нь), Ŭ (Ў), Ł (Л)**
+
+* Added for consistency, Czech: **Ř**
+
+## Installation Steps
+
+1. Download the distribution.
+
+2. Install the Jugoslavica.bundle file with the Keyboard Installer app.
+
+3. Navigate to `System Preferences` → `Keyboard` → `Input sources`, and add `Jugoslavica`
+
+4. To remove the original English layout, temporarily add Vietnamese (simple
+   telex), remove English, and then remove Vietnamese.
+
+5. You might need to log out and log back in for everything to work smoothly.
+
+## Give it a try and enjoy typing with Jugoslavica! 🚀
+
+[1]: https://en.wikipedia.org/wiki/Romanization_of_Bulgarian#Streamlined_System
+
+[2]: https://en.wikipedia.org/wiki/Belarusian_Latin_alphabet