Skip to content

Commit 3fc71c9

Browse files
committed
docs: document handwriting and gguf features
1 parent 5835d63 commit 3fc71c9

2 files changed

Lines changed: 41 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ This fork adds **optional AI-powered features** using Gemini, Groq, and OpenAI-c
1717
## What's New in LeanType
1818

1919
- **[🤖 Multi-Provider AI](docs/FEATURES.md#supported-ai-providers)** - Proofread using **Gemini**, **Groq** (Llama 3, Mixtral), or **OpenAI-compatible** providers. Supports dynamic fetching of latest models directly from providers.
20-
- **[🛡️ Offline AI](docs/FEATURES.md#5-offline-proofreading-privacy-focused)** - Private, on-device proofreading and translation using ONNX models (Offline build only).
20+
- **[🛡️ Offline AI (GGUF)](docs/FEATURES.md#5-offline-proofreading-privacy-focused)** - Private, on-device proofreading and translation using local **GGUF models** powered by `llama.cpp` (Offline build only).
2121
- **🌐 AI Translation** - Translate selected text directly using your chosen AI provider, with a separate model selector.
22+
- **[✍️ Handwriting Input](docs/FEATURES.md#8-handwriting-input)** - Draw characters directly on a handwriting recognition canvas (Standard version, requires [Leantype-Handwriting-Plugin](https://github.com/LeanBitLab/Leantype-Handwriting-Plugin)).
2223
- **[🧠 Custom AI Keys](docs/FEATURES.md#4-custom-ai-keys--keywords)** - Assign custom prompts, personas (#editor, #proofread), and custom text labels/tags (showing as themed capsules) to 10 customizable toolbar keys.
2324
- **📝 Text Expander** - Built-in expansion tool supporting custom shortcuts and dynamic template variables (date, time, clipboard, custom placeholders).
2425
- **🪟 Floating Keyboard** - Detach the keyboard into a draggable window for seamless multitasking. Includes a persistent mode option to keep the keyboard floating.
@@ -31,7 +32,7 @@ This fork adds **optional AI-powered features** using Gemini, Groq, and OpenAI-c
3132
- **🔍 Clipboard Search & Undo** - Search through your clipboard history directly from the toolbar, undo accidental item deletions, and fold/collapse pinned items by default to save space.
3233
- **📸 Screenshot Suggestion & Clipboard** - Suggests recently taken screenshots for quick sharing via the suggestion strip and saves them to your clipboard history.
3334
- **🔎 Emoji Search** - Search for emojis by name. *Requires loading an Emoji Dictionary.*
34-
- **🔒 Privacy Choices** - Choose **Standard** (Opt-in AI), **Offline** (Hard-disabled network, offline model load), or **Offline Lite** (Minimalist, no AI) versions.
35+
- **🔒 Privacy Choices** - Choose **Standard** (Opt-in AI, Handwriting), **Offline** (Hard-disabled network, offline GGUF model load), or **Offline Lite** (Minimalist, no AI) versions.
3536

3637

3738

@@ -76,17 +77,17 @@ This fork adds **optional AI-powered features** using Gemini, Groq, and OpenAI-c
7677
### 📦 Choose Your Version
7778

7879
#### 1. Standard Version (`-standard-release.apk`)
79-
* **Features:** Full suite including **AI Proofreading**, **AI Translation**, and **Gesture Library Downloader**.
80-
* **Permissions:** Request `INTERNET` permission (used *only* when you explicitly use AI features).
81-
* **Setup:** Use the built-in downloader for Gesture Typing. Configure AI keys in Settings.
80+
* **Features:** Full suite including **AI Proofreading**, **AI Translation**, **Handwriting Input**, and **Gesture Library Downloader**.
81+
* **Permissions:** Request `INTERNET` permission (used *only* when you explicitly use AI features, download plugins, or update libraries).
82+
* **Setup:** Use the built-in downloader for Gesture Typing and Handwriting Input. Configure AI keys in Settings.
8283

8384
#### 2. Offline Version (`-offline-release.apk`)
84-
* **Features:** All UI/UX enhancements and **Offline Neural Proofreading** (ONNX).
85+
* **Features:** All UI/UX enhancements and **Offline Neural Proofreading** (via `llama.cpp` using local **GGUF models**).
8586
* **Permissions:** **NO INTERNET PERMISSION**. Guaranteed at OS level.
8687
* **Best For:** Privacy purists.
8788
* **Manual Setup Required:**
8889
* **Gesture Typing:** [Download library manually](https://github.com/erkserkserks/openboard/tree/46fdf2b550035ca69299ce312fa158e7ade36967/app/src/main/jniLibs) and load via *Settings > Gesture typing*.
89-
* **Offline AI:** Download ONNX models and load via *Settings > AI Integration*. 👉 **[See Offline Setup Instructions](docs/FEATURES.md#3-offline-proofreading-privacy-focused)**
90+
* **Offline AI:** Download GGUF models and load via *Settings > Advanced > GGUF Model (.gguf)*. 👉 **[See Offline Setup Instructions](docs/FEATURES.md#5-offline-proofreading-privacy-focused)**
9091

9192
#### 3. Offline Lite Version (`-offlinelite-release.apk`)
9293
* **Features:** All UI/UX enhancements but **NO AI FEATURES**.

docs/FEATURES.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@ LeanType integrates with AI providers to offer advanced proofreading and transla
1515
| 🛡️ **[Offline Proofreading](#5-offline-proofreading-privacy-focused)** | Privacy-first, on-device AI. |
1616
| 📝 **[Text Expander](#6-text-expander)** | Custom text shortcut expansion. |
1717
| 🖱️ **[Touchpad Mode](#7-touchpad-mode)** | Full-screen touchpad gestures and controls. |
18+
| ✍️ **[Handwriting Input](#8-handwriting-input)** | Use handwriting recognition to draw letters directly on a canvas. |
1819

1920
## Summary of New Features
2021

2122
| Feature | Function | Settings Location |
2223
| :--- | :--- | :--- |
2324
| **Multi-Provider AI** | Uses Gemini, Groq, or OpenAI to proofread/rewrite text. Fetch latest models dynamically. | `AI Integration > Set AI Provider` |
2425
| **Offline Proofreading** | Private, on-device AI for grammar (requires downloads). | `AI Integration > Offline Proofreading` |
26+
| **GGUF Model Support** | Load and run highly quantized, compact GGUF models on-device for offline proofreading/translation. | `Advanced > GGUF Model (.gguf)` |
2527
| **Custom AI Keys** | 10 toolbar keys with custom prompts, tags (themed capsules), and toggle settings (supports hashtags). | `AI Integration > Custom Keys` |
2628
| **AI Translation** | Translates selected text via your configured AI provider (includes separate model selector). | Toolbar > Translate Icon |
2729
| **Floating Keyboard** | Detach the keyboard into a draggable window with a persistent mode option. | Toolbar > Floating Keyboard |
@@ -37,6 +39,7 @@ LeanType integrates with AI providers to offer advanced proofreading and transla
3739
| **Screenshot on Clipboard** | Automatically saves taken screenshots to your clipboard history. | *Automatic (when enabled)* |
3840
| **Clipboard Undo** | Undo swipe-to-delete on clipboard items with a timed undo bar. | *Automatic (on swipe delete)* |
3941
| **Text Expander** | Expand custom shortcuts using dynamic template variables (date, time, clipboard, custom placeholders). | `Text correction > Text Expander` |
42+
| **Handwriting Input** | Draw letters or words directly on the screen keyboard space to type (standard variant, requires plugin). | `Libraries > Handwriting Input Plugin` |
4043

4144
---
4245

@@ -340,3 +343,33 @@ Touchpad Mode replaces the keyboard with a laptop-style touchpad overlay to cont
340343
* **Double Tap**: Copies selected text (or Pastes clipboard contents if no selection exists).
341344
* **Triple Tap**: Cuts selected text (or Selects All if no selection exists).
342345
* **Press & Hold (Long Press)**: Deletes (backspaces) selection / word to the left. Repeats automatically if held.
346+
347+
---
348+
349+
## 8. Handwriting Input
350+
351+
> [!NOTE]
352+
> **Availability**: This feature is only available in the **Standard** (`-standard-release.apk`) and **Standard Optimised** build flavors. It is excluded from the **Offline** and **Offline Lite** variants.
353+
354+
LeanType integrates a handwriting recognition canvas that allows you to write characters directly on the keyboard using your finger or a stylus.
355+
356+
### Setup Instructions
357+
358+
1. **Install the Plugin**:
359+
* Go to **Settings > Libraries**.
360+
* Under **Handwriting Input Plugin**, tap **Download** to pull the latest plugin APK from the [Leantype-Handwriting-Plugin](https://github.com/LeanBitLab/Leantype-Handwriting-Plugin) GitHub repository.
361+
* Alternatively, you can tap to load a locally downloaded plugin APK file.
362+
* Review the security warning and confirm the installation. The app will verify and register the plugin.
363+
364+
2. **Accessing the Handwriting Key**:
365+
* The **Handwriting** icon (represented by a pencil/edit icon) is placed on your keyboard toolbar by default in supported variants.
366+
* If it is not showing, you can customize the toolbar under **Settings > Preferences > Keyboard toolbar** to enable it.
367+
368+
### How to Use
369+
370+
1. Tap the **Handwriting** icon in the toolbar.
371+
2. The keyboard area will switch to a handwriting drawing canvas.
372+
3. Draw characters, words, or punctuation symbols on the canvas. The keyboard will automatically inputs recognized characters.
373+
4. Tap the **Clear (X)** button on the bottom row to clear the current drawing canvas.
374+
5. Tap the **Handwriting** icon again to toggle back to the standard keyboard layout.
375+

0 commit comments

Comments
 (0)