diff --git a/README.md b/README.md index 6109553d5f..a7713300af 100644 --- a/README.md +++ b/README.md @@ -6,22 +6,24 @@ Open Source | Platform | Master | Nightly | Beta | Stable | | -------- | :----: | :-----: | :--: | :----: | -| Android | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanAndroid_Build)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanAndroid_NightlyAlpha)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanAndroid_Beta),branch:(default:false)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanAndroid_Stable),branch:(default:false)/statusIcon) | -| Web | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keymanweb_Build)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keymanweb_Nightly)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keymanweb_Beta),branch:(default:false)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keymanweb_Stable),branch:(default:false)/statusIcon)| | Windows | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keyman_Build)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanDesktop_Nightly)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanDesktop_Beta),branch:(default:false)/statusIcon)| ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanDesktop_Stable),branch:(default:false)/statusIcon) | -| Mac | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanMac_Master)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanMac_Nightly)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanMac_Beta),branch:(default:false)/statusIcon)| ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanMac_Stable),branch:(default:false)/statusIcon) | +| macOS | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanMac_Master)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanMac_Nightly)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanMac_Beta),branch:(default:false)/statusIcon)| ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanMac_Stable),branch:(default:false)/statusIcon) | +| Web | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keymanweb_Build)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keymanweb_Nightly)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keymanweb_Beta),branch:(default:false)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keymanweb_Stable),branch:(default:false)/statusIcon)| +| Android | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanAndroid_Build)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanAndroid_NightlyAlpha)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanAndroid_Beta),branch:(default:false)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:KeymanAndroid_Stable),branch:(default:false)/statusIcon) | +| iOS | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keyman_iOS_Master)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keyman_iOS_Nightly)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keyman_iOS_Beta),branch:(default:false)/statusIcon) | ![Build Status](https://build.palaso.org/app/rest/builds/buildType:(id:Keyman_iOS_Stable),branch:(default:false)/statusIcon) | [Keyman](https://keyman.com) makes it possible for you to type in over 1,000 languages on Windows, iPhone, iPad, Android tablets and phones, and even instantly in your web browser. # Getting Started -[Android](./android/README.md) - -[Web](./web/README.md) - +## Desktop Platforms ## [Windows](./windows/src/README.md) +[macOS](./mac/README.md) -[Mac](./mac/README.md) +## Web & Mobile Platforms ## +[Web](./web/README.md) +[Android](./android/README.md) +[iOS](./ios/README.md) # Release Types diff --git a/ios/README.md b/ios/README.md new file mode 100644 index 0000000000..10eedf9494 --- /dev/null +++ b/ios/README.md @@ -0,0 +1,10 @@ +# Keyman for iOS + +## Minimum iOS Requirements +Xcode + +### Compiling from Command line +To build Keyman for iOS, please run the build.sh build script within this folder. +You will need to either run with the command-line argument `-no-codesign` or obtain the necessary security permissions and certificate data as part of our core development team to complete the build for the final app. + +To run the app within a simulator after build.sh is completed, "Run" the Keyman scheme/target within Xcode. diff --git a/ios/Readme.md b/ios/Readme.md deleted file mode 100644 index 10b185980b..0000000000 --- a/ios/Readme.md +++ /dev/null @@ -1,5 +0,0 @@ -To build Keyman for iOS, please run the build.sh build script within this folder. -You will need to either run with the command-line argument -no-codesign or obtain the necessary security permissions and -certificate data as part of our core development team to complete the build for the final app. - -To run the app within a simulator after build.sh is completed, "Run" the Keyman scheme/target within Xcode. diff --git a/web/README.md b/web/README.md index 0db43e202f..81defbd51c 100644 --- a/web/README.md +++ b/web/README.md @@ -1,9 +1,8 @@ -********************************************************************** +# Keyman Web # +The Original Code is (C) 2017 SIL International - KeymanWeb 2.0 - ------------- - - The Original Code is (C) 2017 SIL International +## Minimum Web Requirements +Google Closures Compiler is used to compile the javascript modules into a single module. Java must be installed to run the compiler, which is stored in the tools folder. ********************************************************************** @@ -15,8 +14,5 @@ The following folders contain the distribution for KeymanWeb 2.0: samples Sample and test-case web-pages -Google Closures Compiler is used to compile the javascript modules -into a single module. Java must be installed to run the compiler, -which is stored in the tools folder.