diff --git a/docs/build/index.md b/docs/build/index.md index 6362c38739..c001d6a8f9 100644 --- a/docs/build/index.md +++ b/docs/build/index.md @@ -4,9 +4,9 @@ Keyman has a wide range of dependencies. We are working to reduce the complexity ## Development Platforms -* [Linux - Ubuntu](building-linux-ubuntu.md) -* [macOS](building-macos.md) -* [Windows](building-windows.md) +* [Linux - Ubuntu](linux-ubuntu.md) +* [macOS](macos.md) +* [Windows](windows.md) ## Additional Configuration Documentation @@ -20,6 +20,6 @@ Older notes: * [Keyman for iOS notes](ios-notes.md) * [Keyman for macOS notes](macos-notes.md) * [KeymanWeb notes](web-notes.md) -* [Keyman Core Desktop notes](core-desktop.md) +* [Keyman Core Desktop notes](core-desktop-notes.md) Many folders may also contain other build instructions in README.md files. diff --git a/docs/build/linux-ubuntu.md b/docs/build/linux-ubuntu.md index 2c9da3268c..910a3b8d2d 100644 --- a/docs/build/linux-ubuntu.md +++ b/docs/build/linux-ubuntu.md @@ -1,3 +1,3 @@ -## Setup your Keyman build environment on Ubuntu +# Setup your Keyman build environment on Ubuntu -TODO \ No newline at end of file +TODO diff --git a/docs/build/macos.md b/docs/build/macos.md index e720b7f202..db914ad5aa 100644 --- a/docs/build/macos.md +++ b/docs/build/macos.md @@ -1,6 +1,6 @@ -## Setup your Keyman build environment on macOS +# Setup your Keyman build environment on macOS -### Target Projects +## Target Projects On macOS, you can build the following projects: @@ -12,19 +12,19 @@ On macOS, you can build the following projects: The following libraries can also be built: * Common/Core/Desktop (macOS, wasm targets) -* Common/Core/Web +* Common/Core/Web -The following projects cannot be built on macOS: +The following projects **cannot** be built on macOS: * Keyman for Linux * Keyman for Windows * Keyman Developer -### System Requirements +## System Requirements * Minimum macOS version: macOS Catalina 10.15 or Big Sur 11.0 -### Prerequisites +## Prerequisites Many dependencies are only required for specific projects. @@ -38,11 +38,11 @@ The remaining dependencies can be installed via script: This script will also update your environment to the values in: `resources/devbox/macos/keyman.macos.env.sh` -It will also add this to your `~/.bashrc`. +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 Dependencies * Shared: HomeBrew, Bash 5.0+, jq, Python 3, Meson, Ninja, Rust, coreutils @@ -52,10 +52,10 @@ These dependencies are also listed below if you'd prefer to install manually. brew install rustup-init ``` -* Web: node.js, emscripten, wasm-pack +* Web: node.js, emscripten, wasm-pack, openjdk 8 ```shell - brew install node emscripten wasm-pack + brew install node emscripten wasm-pack openjdk@8 rustup target add wasm32-unknown-unknown ``` diff --git a/docs/build/sentry-cli-notes.md b/docs/build/sentry-cli-notes.md index e312a5e603..968c42e3ae 100644 --- a/docs/build/sentry-cli-notes.md +++ b/docs/build/sentry-cli-notes.md @@ -1,4 +1,4 @@ -#### Setting up sentry-cli +# Setting up sentry-cli Contact the Keyman team if you need access to sentry.keyman.com for development. You will also need to install [sentry-cli](https://docs.sentry.io/cli/installation/) for uploading Debug symbols. diff --git a/docs/build/windows.md b/docs/build/windows.md index 81fc537eae..f0f48e0733 100644 --- a/docs/build/windows.md +++ b/docs/build/windows.md @@ -1,3 +1,3 @@ -## Setup your Keyman build environment on Windows +# Setup your Keyman build environment on Windows TODO