mirror of
https://github.com/keymanapp/keyman.git
synced 2026-08-05 08:25:32 +00:00
Also made the Scheme for the IM build shared in preparation for adding unit tests to thta project. |
||
|---|---|---|
| .. | ||
| Keyman4Mac | ||
| Keyman4MacIM | ||
| KeymanEngine4Mac | ||
| .gitignore | ||
| bashHelperFunctions.sh | ||
| build.sh | ||
| ComponentInputModeDict.rtf | ||
| history.md | ||
| README.md | ||
Keyman for macOS
Minimum Mac Requirements
Xcode 8.3.3 (it might also work to use an older version)
Keyman for macOS Development
Keyman for macOS can be built from a command line (preferred) or Xcode.
Compiling from Command Line
To build Keyman for macOS, do the following:
- Open a Terminal window.
- cd to keyman/mac. build.sh must be run in the directory containing the script.
- Build using
./build.sh -no-codesign. Run./build.sh -helpto see all options.- If you have signing credentials from the core development team, you can build a signed version by omitting
-no-codesign.
- If you have signing credentials from the core development team, you can build a signed version by omitting
Running Keyman
- Deploy Keyman locally using
./build.sh -deploy local -deploy-only.- Alternatively copy keyman/mac/Keyman4MacIM/build/Debug/Keyman.app to ~/Library/Input Methods
- If running for the first time, follow the installation instructions at Installing Keyman for Mac OS X.
Compiling from Xcode
To build using Xcode, you will need to build KeymanEngine4Mac first and then build Keyman4MacIM.
- Launch Xcode
- Open keyman/mac/KeymanEngine4Mac/KeymanEngine4Mac.xcodeproj
- Build the project: Product > Build (or Cmd-B)
- Open keyman/mac/Keyman4MacIM/Keyman4MacIM.xcodeproj
- If you do not have signing credentials from the core development team, disable code signing in Xcode.
- Open the Project Navigator: View > Navigators > Show Project Navigator (Cmd-1)
- Select Keyman4MacIM and click Build Settings
- In the Signing section, change Code Signing Identity to Don't Code Sign. This will modify Keyman4MacIM.xcodeproj. Do not commit the change.
- Build the project. Refer to Running Keyman on how to install the app.
Testing
The Keyman4Mac project builds a test-bed app that can be used to test keyboards without installing the input method. It can also be used as reference for the usage of Keyman Engine.
Keyman4Mac tests are run using ./build.sh -test -no-codesign.