1
0
Fork 0

documentation update

This commit is contained in:
sspanak 2024-02-11 12:57:45 +02:00 committed by Dimo Karaivanov
parent 048ce9cfb4
commit e03c788ebb
4 changed files with 19 additions and 16 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

View file

@ -9,7 +9,7 @@ If you would like to contribute to the project by fixing a bug, adding a new lan
## Building
The recommended way of building is using Android Studio. As the of time of writing this, the current version is: Android Studio Dolphin | 2021.3.1.
The recommended way of building is using Android Studio. As the of time of writing this, the current version is: Android Studio Hedgehog | 2023.1.1.
### Building a Debug .apk
If you have not configured Android Studio yet, follow [the official manual](https://developer.android.com/training/basics/firstapp), then follow the simple steps below to get the project running.

View file

@ -3,17 +3,20 @@ TT9 is an IME (Input Method Editor) for Android devices with a hardware keypad.
This is a modernized version of the [original project](https://github.com/Clam-/TraditionalT9) by Clam-.
## 📦 Install
[<img src="!RAW/get-it-on-github-badge.png"
alt="Get it on GitHub"
height="80">](https://github.com/sspanak/tt9/releases/latest)
[<img src="https://gitlab.com/IzzyOnDroid/repo/-/raw/master/assets/IzzyOnDroid.png"
alt="Get it on IzzyOnDroid"
height="80">](https://apt.izzysoft.de/fdroid/index/apk/io.github.sspanak.tt9)
alt="Get it on IzzyOnDroid"
height="80">](https://apt.izzysoft.de/fdroid/index/apk/io.github.sspanak.tt9)
or get the APK from the [Releases Section](https://github.com/sspanak/tt9/releases/latest).
## Screenshots
## 📷 Screenshots
<img src="screenshots/1.png" width="160" height="177"> <img src="screenshots/3.png" width="160" height="177"> <img src="screenshots/5.png" width="160" height="177">
<img src="screenshots/2.png" width="160" height="177"> <img src="screenshots/4.png" width="160" height="177">
## System Requirements
## ⚙️ System Requirements
- Android 4.4 or higher. _(Tested and confirmed on Android 6.0, 10 and 11)_
- A hardware keypad or a keyboard. For touchscreen-only devices, an on-screen keypad can be enabled in the Settings.
- Minimum 50 Mb of storage space. Extra space is needed for language dictionaries in Predictive Mode.
@ -24,17 +27,17 @@ or get the APK from the [Releases Section](https://github.com/sspanak/tt9/releas
_Storage usage depends on the word roots count, and the average word length in each language. Some languages will require more space, even if they have less words than others._
### Compatibility
### ⚠️ Compatibility
If you own a phone with Android 2.2 up to 4.4, please refer to the original version of Traditional T9 from 2016.
TT9 may not work well on Kyocera phones, some Sonim phones and some other devices that run highly customized Android versions, where all apps are integrated and intended to work with the respective native keyboard. You may experience missing functionality or unexpected text/numbers appearing when you try to type.
## How to Use Traditional T9?
## 🤔 How to Use Traditional T9?
Before using Traditional T9 for the first time you would need to load a dictionary and configure it. After that, you could start typing right away in one of the three modes: Predictive, ABC or Numeric (123). And even if you have mastered the keypad back in the days, you would still find the Predictive mode now provides powerful and smart new ways of typing with even less key presses.
So make sure to read the initial setup and the hotkey tips in the [user manual](docs/user-manual.md).
## Contributing to the Project
## Contributing
As with many other open-source projects, this one is also maintained by its author in his free time. Any help in making Traditional T9 better will be highly appreciated. Here is how:
- Add [a new language](CONTRIBUTING.md#adding-a-new-language), [new UI translations](CONTRIBUTING.md#translating-the-ui) or simply fix a spelling mistake. The process is very simple and even with minimum technical knowledge, your skills as a native speaker will be of great use. Or, if you are not tech-savvy, just [open a new issue](https://github.com/sspanak/tt9/issues) and put the correct translations or words there. Correcting misspelled words or adding new ones is the best you can do to help. Processing millions of words in multiple languages is a very difficult task for a single person.
- [Report bugs](https://github.com/sspanak/tt9/issues) or other unusual behavior on different phones. Currently, the only testing and development devices are: Qin F21 Pro+ / Android 11; Energizer H620SEU / Android 10; Vodaphone VFD 500 / Android 6.0. But Android behaviour and appearance varies a lot across the millions of devices available out there.
@ -42,16 +45,18 @@ As with many other open-source projects, this one is also maintained by its auth
Your PRs are welcome!
## Supporting the Project
## 👍 Support
If you like Traditional T9, buy me a beer. Donations are currently accepted on [buymeacoffee.com](https://www.buymeacoffee.com/sspanak).
## License
Or if you just want to show your appreciation, give the project a star. Higher ranked projects on GitHub have the opportunity to use development tools for free, and apply for funding easier.
## 🕮 License
- The source code, the logo image and the icons are licensed under the conditions described in [LICENSE.txt](LICENSE.txt).
- The dictionaries are licensed under the licenses provided in the [respective readme files](docs/dictionaries), where applicable. Detailed information about the dictionaries is also available there.
- [Silver foil photo created by rawpixel.com - www.freepik.com](https://www.freepik.com/photos/silver-foil)
- "Negotiate" and "Vibrocentric" fonts are under [The Fontspring Desktop/Ebook Font End User License](docs/desktop-ebook-EULA-1.8.txt).
## Privacy Policy and Philosophy
## 💪 Privacy Policy and Philosophy
- No ads.
- No spying, no tracking, no telemetry or reports. No nothing!
- No network connectivity.

View file

@ -1,7 +1,5 @@
# Traditional T9
TT9 is an IME (Input Method Editor) for Android devices with a hardware keypad. It supports multiple languages and predictive text typing, and an on-screen numpad for touchscreen devices.
All source code, documentation and the privacy policy are available on Github: [https://github.com/sspanak/tt9](https://github.com/sspanak/tt9).
This manual explains how to configure and use TT9 in different scenarios. If you are looking for download or installation instructions, please refer to the README on Github: [https://github.com/sspanak/tt9](https://github.com/sspanak/tt9). All source code, the privacy policy, a development guide and additional documentation are also available there.
## Initial Setup
After installing, in order to use Traditional T9, you need to enable it as an Android keyboard. To do so, click on the launcher icon. If you need to take any action, all options besides Initial Setup would be disabled and there would be a label saying TT9 is disabled. Go to Initial Setup and enable it.