114 lines
5.4 KiB
Markdown
114 lines
5.4 KiB
Markdown
<img align="left" width="80" height="80"
|
|
src="fastlane/metadata/android/en-US/images/icon.png" alt="App icon">
|
|
|
|
# FlorisBoard [](https://crowdin.florisboard.patrickgold.dev) [](https://matrix.to/#/#florisboard:matrix.org) 
|
|
|
|
**FlorisBoard** is a free and open-source keyboard for Android 6.0+
|
|
devices. It aims at being modern, user-friendly and customizable while
|
|
fully respecting your privacy. Currently in early-beta state.
|
|
|
|
<table>
|
|
<tr>
|
|
<th align="center" width="50%">
|
|
<h3>Stable <a href="https://github.com/florisboard/florisboard/releases/latest"><img alt="Latest stable release" src="https://img.shields.io/github/v/release/florisboard/florisboard"></a></h3>
|
|
</th>
|
|
<th align="center" width="50%">
|
|
<h3>Beta <a href="https://github.com/florisboard/florisboard/releases"><img alt="Latest beta release" src="https://img.shields.io/github/v/release/florisboard/florisboard?include_prereleases"></a></h3>
|
|
</th>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">
|
|
<p><i>Major versions only, 1 release per 1-5 months</i><br><br>Updates are more polished, new features are matured and tested through to ensure a stable experience.</p>
|
|
</td>
|
|
<td valign="top">
|
|
<p><i>Beta versions, up to 1-2 releases per week</i><br><br>Updates contain new features that may not be fully matured yet and bugs are more likely to occur. Allows you to give early feedback.</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">
|
|
<p><a href="https://f-droid.org/packages/dev.patrickgold.florisboard"><img src="https://fdroid.gitlab.io/artwork/badge/get-it-on.png" height="64" alt="F-Droid badge"></a></p>
|
|
<p>
|
|
|
|
**Google Play**: Join the [FlorisBoard Test Group](https://groups.google.com/g/florisboard-public-alpha-test), then visit the [testing page](https://play.google.com/apps/testing/dev.patrickgold.florisboard). Once joined and installed, updates will be delivered like for any other app. ([Store entry](https://play.google.com/store/apps/details?id=dev.patrickgold.florisboard))
|
|
|
|
</p>
|
|
<p>
|
|
|
|
**Manual**: Download and install the APK from the release page.
|
|
|
|
</p>
|
|
</td>
|
|
<td valign="top">
|
|
<p><a href="https://apt.izzysoft.de/fdroid/index/apk/dev.patrickgold.florisboard.beta"><img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png" height="64" alt="IzzySoft repo badge"></a></p>
|
|
<p>
|
|
|
|
**Google Play**: Join the [FlorisBoard Test Group](https://groups.google.com/g/florisboard-public-alpha-test), then visit the [beta testing page](https://play.google.com/apps/testing/dev.patrickgold.florisboard.beta). Once joined and installed, updates will be delivered like for any other app. ([Store entry](https://play.google.com/store/apps/details?id=dev.patrickgold.florisboard.beta))
|
|
|
|
</p>
|
|
<p>
|
|
|
|
**Manual**: Download and install the APK from the release page.
|
|
|
|
</p>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
Beginning with v0.4.0 FlorisBoard will follow [SemVer](https://semver.org/#summary) versioning scheme and enter the public beta on Google Play.
|
|
|
|
## Highlighted features
|
|
- Spell checking service
|
|
- Word suggestions (currently English only and may not work on all devices)
|
|
- Glide typing (currently English only)
|
|
- Advanced theming support and customization
|
|
- Integrated clipboard manager / history
|
|
- Emoji keyboard (although lacking some features)
|
|
|
|
Feature roadmap: See [ROADMAP.md](ROADMAP.md)
|
|
|
|
## Contributing
|
|
Wanna contribute to FlorisBoard? That's great to hear! There are lots of
|
|
different ways to help out. Bug reporting, making pull requests,
|
|
translating FlorisBoard to make it more accessible, etc. For more
|
|
information see the [contributing guidelines](CONTRIBUTING.md). Thank
|
|
you for your help!
|
|
|
|
## List of permissions FlorisBoard requests
|
|
Please refer to this [page](https://github.com/florisboard/florisboard/wiki/List-of-permissions-FlorisBoard-requests)
|
|
to get more information on this topic.
|
|
|
|
## Used libraries, components and icons
|
|
* [Google Flexbox Layout for Android](https://github.com/google/flexbox-layout)
|
|
by [google](https://github.com/google)
|
|
* [Google Material icons](https://github.com/google/material-design-icons) by
|
|
[google](https://github.com/google)
|
|
* [KotlinX serialization library](https://github.com/Kotlin/kotlinx.serialization) by
|
|
[Kotlin](https://github.com/Kotlin)
|
|
* [ColorPicker preference](https://github.com/jaredrummler/ColorPicker) by
|
|
[Jared Rummler](https://github.com/jaredrummler)
|
|
* [Timber](https://github.com/JakeWharton/timber) by
|
|
[JakeWharton](https://github.com/JakeWharton)
|
|
* [expandable-fab](https://github.com/nambicompany/expandable-fab) by
|
|
[Nambi](https://github.com/nambicompany)
|
|
* [ICU4C](https://github.com/unicode-org/icu) by
|
|
[The Unicode Consortium](https://github.com/unicode-org)
|
|
* [Nuspell](https://github.com/nuspell/nuspell) by
|
|
[Nuspell](https://github.com/nuspell)
|
|
|
|
## License
|
|
```
|
|
Copyright 2020 Patrick Goldinger
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
```
|