some adjustments after renaming the package

This commit is contained in:
Helium314 2024-01-31 21:12:34 +01:00
parent 40f39a70d0
commit 1490ddddd8
6 changed files with 16 additions and 69 deletions

View file

@ -1,4 +1,3 @@
IMPORTANT: The package will be renamed soon. To avoid merge conflicts, please do not submit any PRs until the renaming is done.
<!--
* Please bescribe briefly what your pull request proposes to fix or improve.
* If it's not completely obvious, describe what the PR does to achieve the desired result.

View file

@ -1,28 +1,17 @@
# OpenBoard upgrade, WIP
IMPORTANT: The package will be renamed soon. To avoid merge conflicts, please do not submit any PRs until the renaming is done.
## Table of contents
- [Features](#features)
* [Hidden functionality](#hidden-functionality)
* [Hidden Functionality](#hidden-functionality)
- [Contributing](#contributing-)
* [Reporting issues](#reporting-issues)
* [Reporting Issues](#reporting-issues)
* [Translation](#translation)
* [Dictionary creation](#dictionary-creation)
* [Code contribution](#code-contribution)
* [Dictionary Creation](#dictionary-creation)
* [Code Contribution](#code-contribution)
- [License](#license)
- [Credits](#credits)
## Plan for actual release
The plans for major changes are completed, and most features appear to be stable enough for a proper release.
So what comes next:
* Work on issues with the [when ready](https://github.com/Helium314/openboard/labels/when%20ready) label
* Rename app, package and this repository
* New icon
* Use a translation tool (probably weblate)
* Release on F-Droid
* Maybe add a version that does not allow providing a glide typing library, for people concerned about security
## Features
* Allow loading Glide typing library
* not included in the app, as there is no compatible open source library
@ -43,7 +32,7 @@ So what comes next:
* Add custom keyboard [layouts](layouts.md)
* Adjustable bottom padding
## Hidden functionality
## Hidden Functionality
Features that may go unnoticed, and further potentially useful information
* Long-pressing the Clipboard Key (the optional one in the suggestion strip) pastes system clipboard contents.
* Long-pressing keys in the suggestion strip toolbar pins them to the suggestion strip.
@ -69,7 +58,7 @@ Features that may go unnoticed, and further potentially useful information
# Contributing ❤
## Reporting issues
## Reporting Issues
Whether you encountered a bug, or want to see a new feature in OpenBoard, you can contribute to the project by opening a new issue [here](https://github.com/openboard-team/openboard/issues). Your help is always welcome!
@ -81,14 +70,13 @@ Before opening a new issue, be sure to check the following:
## Translation
Currently there is no simple way of translating the app, but it's coming soon...
## Dictionary creation
## Dictionary Creation
There will not be any further dictionaries bundled in this app. However, you can add dictionaries to the [dictionaries repository](https://codeberg.org/Helium314/aosp-dictionaries).
To create or update a dictionary for your language, you can use [this tool](https://github.com/remi0s/aosp-dictionary-tools). You will need a wordlist, as described [here](https://codeberg.org/Helium314/aosp-dictionaries/src/branch/main/wordlists/sample.combined) and in the repository readme.
## Code contribution
IMPORTANT: The package will be renamed soon. To avoid merge conflicts, please do not submit any PRs until the renaming is done.
## Code Contribution
### Getting started
### Getting Started
OpenBoard project is based on Gradle and Android Gradle Plugin. To get started, you can install [Android Studio](https://developer.android.com/studio), and import project 'from Version Control / Git / Github' by providing this git repository [URL](https://github.com/Helium314/openboard) (or git SSH [URL](git@github.com:Helium314/openboard.git)).
Of course you can also use any other compatible IDE, or work with text editor and command line.
@ -110,11 +98,11 @@ If your contribution contains code that is not your own, provide a link to the s
In addition to previous elements, OpenBoard must stick to [F-Droid inclusion guidelines](https://f-droid.org/docs/Inclusion_Policy/).
### Adding layouts
### Adding Layouts
See [layouts.md](layouts.md) for how to add new layouts to the app.
### Update emojis
### Update Emojis
See make-emoji-keys tool [README](tools/make-emoji-keys/README.md).

View file

@ -133,10 +133,10 @@ cc_library {
local_include_dirs: ["src"],
srcs: [
"org_dslul_openboard_inputmethod_keyboard_ProximityInfo.cpp",
"org_dslul_openboard_inputmethod_latin_BinaryDictionary.cpp",
"org_dslul_openboard_inputmethod_latin_BinaryDictionaryUtils.cpp",
"org_dslul_openboard_inputmethod_latin_DicTraverseSession.cpp",
"com_android_inputmethod_keyboard_ProximityInfo.cpp",
"com_android_inputmethod_latin_BinaryDictionary.cpp",
"com_android_inputmethod_latin_BinaryDictionaryUtils.cpp",
"com_android_inputmethod_latin_DicTraverseSession.cpp",
"jni_common.cpp",
":LATIN_IME_CORE_SRC_FILES",

View file

@ -1,2 +0,0 @@
json_key_file("/home/daniele/Documenti/chiavi/api-6930663337756230740-637209-3adcd2d0f296.json") # Path to the json secret file - Follow https://docs.fastlane.tools/actions/supply/#setup to get one
package_name("org.dslul.openboard.inputmethod.latin") # e.g. com.krausefx.app

View file

@ -1,38 +0,0 @@
# This file contains the fastlane.tools configuration
# You can find the documentation at https://docs.fastlane.tools
#
# For a list of all available actions, check out
#
# https://docs.fastlane.tools/actions
#
# For a list of all available plugins, check out
#
# https://docs.fastlane.tools/plugins/available-plugins
#
# Uncomment the line if you want fastlane to automatically update itself
# update_fastlane
default_platform(:android)
platform :android do
desc "Runs all the tests"
lane :test do
gradle(task: "test")
end
desc "Submit a new Beta Build to Crashlytics Beta"
lane :beta do
gradle(task: "clean assembleRelease")
crashlytics
# sh "your_script.sh"
# You can also use other beta testing services here
end
desc "Deploy a new version to the Google Play"
lane :deploy do
gradle(task: "clean assembleRelease")
upload_to_play_store
end
end

View file

@ -40,5 +40,5 @@ One special label that might be wanted though is `$$$`, which will be replaced b
* Use `%` to mark all preceding keys as "_Language (important)_" instead. Keys after `%` will still be in the "_Language_" group.
* The `punctuation` key is typically the period key. `morekeys` set here override the default.
* `[labels]` may contain non-default labels for the following keys `symbol`, `alphabet`, `shift_symbol`, `shift_symbol_tablet`, `comma`, `period`, `question`
* `[number_row]` may contain a custom number row (1-9 and 0 separated by space). You should also add the language to `numberRowLocales` in [`PreferencesSettingsFragment`](app/src/main/java/org/dslul/openboard/inputmethod/latin/settings/PreferencesSettingsFragment.java) so the user can opt into having a localized number row.
* `[number_row]` may contain a custom number row (1-9 and 0 separated by space). You should also add the language to `numberRowLocales` in [`PreferencesSettingsFragment`](app/src/main/java/helium314/keyboard/latin/settings/PreferencesSettingsFragment.java) so the user can opt into having a localized number row.
* `[extra_keys]` are typically keys shown in the default layout of the language. This is currently only used for latin layouts to avoid duplicating layouts for just adding few keys on the right side. The layout name need to end with `+`, but the `+` is removed when looking up the actual layout.