From 723e74fdf8871626597b7966e204ded9331fa2bd Mon Sep 17 00:00:00 2001 From: Marc Durdin Date: Fri, 8 Oct 2021 14:06:45 +1100 Subject: [PATCH] chore: additional links and docs --- CONTRIBUTING.md | 16 ++++++- LICENSE.md | 31 ++++++++++++++ README.md | 85 ++++++++------------------------------ docs/build/linux-ubuntu.md | 4 +- docs/build/windows.md | 8 ++++ 5 files changed, 74 insertions(+), 70 deletions(-) create mode 100644 LICENSE.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e373860a71..ce2e5c8fec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,6 +20,8 @@ The following is a set of guidelines for contributing to Keyman, Keyman keyboard * [Suggesting Enhancements](#suggesting-enhancements) * [Your First Code Contribution](#your-first-code-contribution) * [Building Keyman](#building-keyman) + * [Localize Keyman](#localize-keyman) + * [Other Ways of Getting Involved](#other-ways-of-getting-involved) [Style Guides](#style-guides) * [Principles of Keyman Code Changes](#principles-of-keyman-code-changes) @@ -143,7 +145,19 @@ Unsure where to begin contributing to Keyman? You can start by looking through t ### Building Keyman -Keyman can be built locally. For instructions on how to do this, see the [build documentation](https://github.com/keymanapp/keyman/blob/master/docs/build/index.md). +Keyman can be built locally. For instructions on how to do this, see the [build documentation](./docs/build/index.md). + +### Localize Keyman + +We use CrowdIn to develop translations for the Keyman user interface. + +* [Localize Keyman](https://translate.keyman.com/project/keyman) [![Crowdin](https://badges.crowdin.net/keyman/localized.svg)](https://translate.keyman.com/project/keyman) + +### Other Ways of Getting Involved + +Even if you are not a coder, there are many other ways you can help with the Keyman project: + +* [Other Ways of Getting Involved](https://keyman.com/about/get-involved) ## Style Guides diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000000..24c907d61f --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,31 @@ +# License + +Copyright (c) 2017-2021 SIL International. All rights reserved. + +Licensed under the MIT License. + +[Keyman for Linux](./linux) is licensed under the MIT License apart from [ibus-kmfl](./linux/ibus-kmfl) which is licensed under the GNU General Public License as published by the Free Software Foundation; either [version 2](./linux/ibus-kmfl/COPYING) of the License, or (at your option) any later version. + +--- + +The MIT License + +Copyright (c) 2017-2021 SIL International + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md index d2502d91ba..6e71ad0d4c 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,28 @@ ![Keyman](https://keyman.com/cdn/dev/img/logo2.png) -[Keyman](https://keyman.com) makes it possible for you to type in any language on Windows, macOS, Linux, iPhone, iPad, Android tablets and phones, and even instantly in your web browser. Create keyboard layouts with Keyman Developer and share them with the community in the [keyboards repository](https://github.com/keymanapp/keyboards). The [Keyman Community](https://community.software.sil.org/c/keyman) have already contributed keyboard layouts for over 1,500 languages! - -Keyman is an open source project distributed under the MIT license. - -# Get Involved - -[![Crowdin](https://badges.crowdin.net/keyman/localized.svg)](https://translate.keyman.com/project/keyman) - -[Get involved](https://keyman.com/about/get-involved) - -[comment]: # (CI Build statuses) - -Development Status on [status.keyman.com](https://status.keyman.com) - -| Platform | Alpha | Beta | Stable | -| -------- | :---: | :--: | :----: | -| Windows | ![Alpha][win-master] | ![Beta][win-beta]| ![Stable][win-stable] | -| macOS | ![Alpha][mac-master] | ![Beta][mac-beta]| ![Stable][mac-stable] | -| Web | ![Alpha][web-master] | ![Beta][web-beta]| ![Stable][web-stable] | -| Android | ![Alpha][android-master] | ![Beta][android-beta]| ![Stable][android-stable] | -| iOS | ![Alpha][ios-master] | ![Beta][ios-beta]| ![Stable][ios-stable] | -| Linux | ![Alpha][linux-master] | ![Beta][linux-beta]| ![Stable][linux-stable] | - -# Getting Started - -## Desktop Platforms ## -* [Windows](./windows/src/README.md) -* [macOS](./mac/README.md) -* [Linux](./linux/README.md) - -## Web & Mobile Platforms ## -* [Web](./web/README.md) -* [Android](./android/README.md) -* [iOS](./ios/README.md) - -# Release Types - -Each platform maintains multiple types of releases: - -* Stable: A released version. On a `stable` or `stable-` branch. -* Beta: A version that is nearing full "stable" release. On the `beta` branch. -* Alpha: Contains the very latest code. These versions are published daily whenever the code changes. On `master` branch. +[Keyman](https://keyman.com) makes it possible for you to type in any language on Windows, macOS, Linux, iPhone, iPad, Android tablets and phones, and even instantly in your web browser. Create keyboard layouts with Keyman Developer and share them with the community in the [keyboards repository](https://github.com/keymanapp/keyboards). The [Keyman Community](https://community.software.sil.org/c/keyman) have already contributed keyboard layouts for over 2,000 languages! # License -Copyright (c) 2018-2021 SIL International. All rights reserved. +Copyright (c) SIL International. -Licensed under the [MIT](./windows/src/LICENSE.md) License. +Keyman is an open source project distributed under the [MIT license](LICENSE.md). -[Keyman for Linux](./linux) is licensed under the [MIT](./windows/src/LICENSE.md) License apart from [ibus-kmfl](./linux/ibus-kmfl) which is licensed under the GNU General Public License as published by the Free Software Foundation; either [version 2](./linux/ibus-kmfl/COPYING) of the License, or (at your option) any later version. +# Get Involved -[comment]: # (CI Build status links) +* [Code of Conduct](CODE_OF_CONDUCT.md) +* [Contributing to the Keyman App](CONTRIBUTING.md) +* [Localize Keyman](https://translate.keyman.com/project/keyman) +* [Other Ways of Getting Involved](https://keyman.com/about/get-involved) - [win-master]:https://build.palaso.org/app/rest/builds/buildType:(id:Keyman_Build)/statusIcon - [win-beta]:https://build.palaso.org/app/rest/builds/buildType:(id:KeymanDesktop_Beta)/statusIcon - [win-stable]:https://build.palaso.org/app/rest/builds/buildType:(id:KeymanDesktop_Stable),branch:(default:false)/statusIcon - [mac-master]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanMac_Master)/statusIcon - [mac-beta]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanMac_Beta)/statusIcon - [mac-stable]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanMac_Stable),branch:(default:false)/statusIcon - [web-master]: https://build.palaso.org/app/rest/builds/buildType:(id:Keymanweb_Build)/statusIcon - [web-beta]: https://build.palaso.org/app/rest/builds/buildType:(id:Keymanweb_Beta)/statusIcon - [web-stable]: https://build.palaso.org/app/rest/builds/buildType:(id:Keymanweb_Stable),branch:(default:false)/statusIcon - [android-master]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanAndroid_Build)/statusIcon - [android-beta]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanAndroid_Beta)/statusIcon - [android-stable]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanAndroid_Stable),branch:(default:false)/statusIcon - [ios-master]: https://build.palaso.org/app/rest/builds/buildType:(id:Keyman_iOS_Master)/statusIcon - [ios-beta]: https://build.palaso.org/app/rest/builds/buildType:(id:Keyman_iOS_Beta)/statusIcon - [ios-stable]: https://build.palaso.org/app/rest/builds/buildType:(id:Keyman_iOS_Stable),branch:(default:false)/statusIcon - [linux-master]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanLinux_Master)/statusIcon - [linux-beta]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanLinux_Beta)/statusIcon - [linux-stable]: https://build.palaso.org/app/rest/builds/buildType:(id:KeymanLinux_Stable),branch:(default:false)/statusIcon +# Development Status -# Notes for Contributors +* [Development Status Site](https://status.keyman.com) -When cloning this repo for local development on a Windows machine, take care not to place it overly deep in your file system. -Some of the paths for compilation can push character lengths around 160 characters long, while certain operations on Windows systems may be limited to paths of 260 characters or less. -For example, [`git clean` on Windows with msys](https://stackoverflow.com/questions/22575662/filename-too-long-in-git-for-windows/22575737#22575737) is limited due to dependence on older Windows APIs. +# Important Links + +* [Keyman Home](https://keyman.com) +* [Downloads](https://keyman.com/downloads) +* [Keyboards](https://keyman.com/keyboards) +* [Documentation](https://help.keyman.com/) +* [Online Keyboard](https://keymanweb.com/) diff --git a/docs/build/linux-ubuntu.md b/docs/build/linux-ubuntu.md index 910a3b8d2d..2a6df289df 100644 --- a/docs/build/linux-ubuntu.md +++ b/docs/build/linux-ubuntu.md @@ -1,3 +1,5 @@ # Setup your Keyman build environment on Ubuntu -TODO +* ([interim notes](../../linux/README.md)) + +TODO \ No newline at end of file diff --git a/docs/build/windows.md b/docs/build/windows.md index f0f48e0733..8a4d84154e 100644 --- a/docs/build/windows.md +++ b/docs/build/windows.md @@ -1,3 +1,11 @@ # Setup your Keyman build environment on Windows TODO + +* [interim notes](../../windows/src/README.md) + +# Notes for Contributors + +When cloning this repo for local development on a Windows machine, take care not to place it overly deep in your file system. +Some of the paths for compilation can push character lengths around 160 characters long, while certain operations on Windows systems may be limited to paths of 260 characters or less. +For example, [`git clean` on Windows with msys](https://stackoverflow.com/questions/22575662/filename-too-long-in-git-for-windows/22575737#22575737) is limited due to dependence on older Windows APIs.