From fb3c8bfb839d5666fca2f2a00d34e94cd13d99d0 Mon Sep 17 00:00:00 2001 From: jahorton Date: Thu, 10 Jun 2021 08:04:19 +0700 Subject: [PATCH] docs(ios): minor readme tweak re Web prereqs --- ios/README.md | 6 +++--- web/README.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/ios/README.md b/ios/README.md index cacaabf271..e79d99884f 100644 --- a/ios/README.md +++ b/ios/README.md @@ -3,7 +3,6 @@ ## Prerequisites * Xcode 11 * iOS 9+ -* [Node.js](https://nodejs.org/) 8.9+ (for building the embedded KeymanWeb engine) * SwiftLint (`brew install swiftlint`) * Carthage 0.37+ (`brew install carthage`) * Pandoc (`brew install pandoc`) @@ -12,6 +11,9 @@ * sentry-cli (`brew install getsentry/tools/sentry-cli`) to utilize Sentry-based error reporting * jq (`brew install jq`) * `bash` (`brew install bash`) +* Building Keyman Web is a precursor for compiling KMEI, so verify your system has all the [Minimum Web Compilation Requirements](../web/README.md#minimum-web-compilation-requirements), including (but not limited to): + - [Node.js](https://nodejs.org/) 8.9+ (for building the embedded KeymanWeb engine) + - [Java 7+](https://adoptopenjdk.net/releases.html) Note that the `brew` command mentioned above is Homebrew, which may be found at https://brew.sh/. While not strictly necessary, it certainly simplifies installing the prerequisites above. @@ -22,8 +24,6 @@ The source for our published iOS Keyman app is found within the **keyman/** subd the views specific to the Keyman app, while the core functionality is found in KeymanEngine.framework. ### Building -Building Keyman Web is a precursor for compiling KMEI, so verify your system has all the [Minimum Web Compilation Requirements](../web/README.md#minimum-web-compilation-requirements) - To build Keyman for iOS, please run the build.sh build script within this folder. You will need to run with the command-line argument `-no-codesign` or establish alternate code-signing permissions to complete the build for the final app. diff --git a/web/README.md b/web/README.md index 2b3979d2e7..01d6a5da41 100644 --- a/web/README.md +++ b/web/README.md @@ -3,7 +3,7 @@ The Original Code is (C) 2017-2018 SIL International ## Minimum Web Compilation Requirements -* Java 7+ (required by the Google Closure Compiler) +* [Java 7+](https://adoptopenjdk.net/releases.html) (required by the Google Closure Compiler) * This can be ignored for Keyman Developer builds. * A local installation of [Node.js](https://nodejs.org/) v8.9+. * Builds will call `npm install` to automatically install further necessary build dependencies.