erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 16:35:33 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11
spiegel-keyman/docs/build/macos.md
Marc Durdin d3a528f96f chore(core): update config notes for emscripten
2022-08-01 14:36:21 +10:00

3.6 KiB
Raw Blame History

Setup your Keyman build environment on macOS

This document describes prerequisites and tools required for building various Keyman projects on macOS. Each project will also have additional notes linked below.

Target Projects

On macOS, you can build the following projects:

The following libraries can also be built:

  • core (macOS, wasm targets)
  • Common/Web

The following projects cannot be built on macOS:

  • Keyman for Linux
  • Keyman for Windows
  • Keyman Developer

System Requirements

  • Minimum macOS version: macOS Catalina 10.15 or Big Sur 11.0

Note: to make a fully M1-compatible release build of Keyman for macOS (for the setup Applescript), Big Sur 11.0 is required, as osacompile on earlier versions does not build for arm64 (M1). The build will still work on earlier versions, but the installer won't be able to run on M1 Macs that do not have Rosetta 2 installed.

Prerequisites

Many dependencies are only required for specific projects.

  • XCode (iOS, macOS) 12.4 or later
    • Install from App Store
    • Accept the Xcode license: sudo xcodebuild -license accept

The remaining dependencies can be installed via script: resources/devbox/macos/macos.sh

This script will also update your environment to the values in: resources/devbox/macos/keyman.macos.env.sh

It will also add these environment settings to your ~/.bashrc.

These dependencies are also listed below if you'd prefer to install manually.

Shared Dependencies

  • Shared: HomeBrew, Bash 5.0+, jq, Python 2.7, Python 3, Meson, Ninja, coreutils, Pandoc

    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
brew install bash jq python3 meson ninja coreutils pandoc pyenv
# Python 2.7 required for DeviceKit (among others?) at present
pyenv install 2.7.18
pyenv global 2.7.18
echo 'eval "$(pyenv init --path)"' >> ~/.bash_profile

    On M1 only (as greadlink is not on the path otherwise in XCode):

    sudo ln -s /opt/homebrew/bin/greadlink /usr/local/bin/greadlink

  • Web: node.js, emscripten, openjdk 8

    brew install node emscripten openjdk@8

    Note: if you install emscripten with brew on macOS, only emscripten binaries are added to the path via symlinks. This makes it reasonably safe to have emscripten on the path, unlike on other platforms where emscripten also ends up adding its versions of node, python, and other binaries to the path.

  • iOS: swiftlint, carthage

    brew install swiftlint carthage

  • macOS: carthage, cocoapods

    brew install carthage cocoapods

  • Android: openjdk 8, Android SDK, Android Studio, Ant, Gradle, Maven

    brew install openjdk@8 android-sdk android-studio ant gradle maven
# update path
source ../resources/devbox/macos/keyman.macos.env.sh
# optionally install sdk images
sdkmanager "system-images;android-30;google_apis;armeabi-v7a"
sdkmanager --update
sdkmanager --licenses

  • kmcomp (optional): WINE

    • Required to build keyboards using kmcomp
    brew tap homebrew/cask-versions
brew install --cask --no-quarantine wine-stable

  • sentry-cli (optional)

    • Uploading symbols for Sentry-based error reporting
    brew install getsentry/tools/sentry-cli

  • Run Android Studio once after installation to install additional components such as emulator images and SDK updates.