Skip to content

Latest commit

 

History

History
153 lines (125 loc) · 5.97 KB

README.md

File metadata and controls

153 lines (125 loc) · 5.97 KB
Raw

App icon

FlorisBoard Release Crowdin

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 alpha/early-beta state.

Public Alpha Test Programme

Wanna try it out on your device? Use one of the following options:

A. IzzySoft's repo for F-Droid:

IzzySoft repo badge

B. Google Play Public Alpha Test:

You can join the public alpha test programme on Google Play. To become a tester, follow these steps:

  1. Join the FlorisBoard Public Alpha Test Google Group to be able to access the testing programme.
  2. Go to the FlorisBoard Testing Page, then click "Become a tester". Now you are enrolled in the testing programme.
  3. To try out FlorisBoard, download it via Google Play. To do so, click on "Download it on Google Play", which takes you to the PlayStore listing.
  4. Finished! You will receive future versions of FlorisBoard via Google Play.

C. Use the APK provided in the release section of this repo

Giving feedback

If you want to give feedback to FlorisBoard, there are several ways to do so, as listed here.

Note on F-Droid release

FlorisBoard is currently available through Google Play and IzzySoft's repo for F-Droid, but is in the inclusion process for the main F-Droid repo. Planned proper F-Droid release is version 0.3.0.

Preview image

Feature roadmap

Basics

  • Implementation of the keyboard core (InputMethodService)
  • Custom implementation of deprecated KeyboardView (base only)
  • Caps + Caps Lock
  • Key popups
  • Extended key popups (e.g. a -> á, à, ä, ...)
  • Key press sound/vibration
  • Portrait orientation support
  • Landscape orientation support (needs tweaks)
  • Tablet screen support (0.4.0)

Layouts

  • Latin character layouts (QWERTY, QWERTZ, AZERTY, Swiss, Spanish, Norwegian, Swedish/Finnish, Icelandic, Danish); more coming in future versions
  • Non-latin character layouts (Persian)
  • Adapt to situation in app (password, url, text, etc. )
  • Special character layout(s)
  • Numeric layout
  • Numeric layout (advanced)
  • Phone number layout
  • Emoji layout (tweaks: 0.3.0)
  • Emoticon layout
  • Kaomoji layout (0.5.0)

Preferences

  • Setup wizard
  • Preferences screen
  • Customize look and behaviour of keyboard
  • Theme presets (currently only day/night theme)
  • Theme customization
  • Theme import/export (0.4.0 or 0.5.0)
  • Subtype selection (language/layout)
  • Keyboard behaviour preferences
  • Text suggestion / Auto correct preferences (0.4.0 or 0.5.0)
  • Gesture preferences (0.3.0)

Composing suggestions (0.4.0 or 0.5.0)

  • Auto suggest words from precompiled dictionary
  • Auto suggest words from user dictionary
  • Auto suggest contacts
  • Multilingual typing

Other useful features

  • One-handed mode
  • Clipboard/cursor tools
  • Integrated number row / symbols in character layouts (0.3.0)
  • Floating keyboard (0.4.0)
  • Gesture support (0.3.0)
  • Glide typing (0.4.0)
  • Full integration in IME service list of Android (xml/method) (integration is internal-only, because Android's default subtype implementation not really allows for dynamic language/layout pairs, only compile-time defined ones)
  • Description and settings reference in System Language & Input
  • (dev only) Generate well-structured documentation of code
  • ...

Note:

(?) = not sure if it will be implemented

(0.x.0) = planned version when feature will be implemented.

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. Thank you for your help!

List of permissions FlorisBoard requests

Please refer to this page to get more information on this topic.

Used libraries, components and icons

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

https://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.