Skip to content

Commit bd2fb37

Browse files
docs: restore app icon, screenshots showcase, capabilities table and fix SVG XML escaping
1 parent 18e7f3a commit bd2fb37

94 files changed

Lines changed: 193 additions & 110 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
<div align="center">
22

3+
<p align="center">
4+
<img src="docs/LastChat_icon.png" alt="Local AI" width="132" />
5+
</p>
6+
7+
# Local AI
8+
9+
<p align="center">
10+
<b>An open-source, on-device AI assistant for Android</b><br/>
11+
Material 3 Expressive UI · multi-provider model routing · local RAG memory · PRoot Linux tool sandbox · a web UI you open from any browser on your Wi-Fi.
12+
</p>
13+
14+
<br>
15+
316
<picture>
417
<source media="(prefers-color-scheme: dark) and (max-width: 640px)" srcset="assets/readme/dark/hm-hero.svg">
518
<source media="(prefers-color-scheme: dark)" srcset="assets/readme/dark/hero.svg">
@@ -29,6 +42,37 @@
2942

3043
</div>
3144

45+
46+
47+
---
48+
49+
<div align="center">
50+
51+
## 📸 A quick look
52+
53+
<table>
54+
<tr>
55+
<td align="center" width="33%">
56+
<img src="docs/1.4.3_chat.jpg" alt="Chat with tools and reasoning" width="240" /><br/>
57+
<sub><b>Chat</b> — reasoning timer, tool badges, rendered SVG answer</sub>
58+
</td>
59+
<td align="center" width="33%">
60+
<img src="docs/1.4.3_memory.jpg" alt="Memory settings" width="240" /><br/>
61+
<sub><b>Memory</b> — memory modes, RAG retrieval, memory search tool</sub>
62+
</td>
63+
<td align="center" width="33%">
64+
<img src="docs/1.4.3_stats.jpg" alt="Statistics" width="240" /><br/>
65+
<sub><b>Statistics</b> — activity heatmap, conversations, tokens</sub>
66+
</td>
67+
</tr>
68+
</table>
69+
70+
<p align="center"><sub>More screenshots per release live in <a href="docs/"><code>docs/</code></a>, including provider setup walkthroughs (<code>1.1.6_providers_use.gif</code>, <code>1.3.4_providers_use.gif</code>).</sub></p>
71+
72+
</div>
73+
74+
---
75+
3276
<h3 id="overview"><picture><source media="(prefers-color-scheme: dark) and (max-width: 640px)" srcset="assets/readme/dark/hm-overview.svg"><source media="(prefers-color-scheme: dark)" srcset="assets/readme/dark/h-overview.svg"><source media="(max-width: 640px)" srcset="assets/readme/light/hm-overview.svg"><img src="assets/readme/light/h-overview.svg" alt="Overview: Privacy-first on-device AI assistant with Linux sandbox & Material 3 Expressive" width="100%"></picture></h3>
3377

3478
**Local AI** is a state-of-the-art, open-source AI assistant application for Android engineered around **Google's Material 3 Expressive** design system.
@@ -51,6 +95,18 @@ All conversations, API keys, documents, vector embeddings, and tool executions r
5195
<tr><td><b>License</b></td><td>GNU General Public License v3.0 (GPL-3.0)</td></tr>
5296
</tbody></table>
5397

98+
#### 💡 What you can actually do with it
99+
100+
| I want to… | Local AI does it with… |
101+
| :--- | :--- |
102+
| **Chat with GPT / Claude / Gemini / DeepSeek / Ollama** | One assistant definition, per-assistant model choice, 62 provider presets in the bundled catalog, plus custom OpenAI-compatible endpoints |
103+
| **Keep long-term context without cloud memory** | Local RAG memory: episodic chunks embedded by an embedding model you pick, stored on device, recalled by cosine similarity |
104+
| **Ask a model to do tasks on my phone** | Built-in tools: `eval_javascript`, `text_to_speech`, `generate_image`, `send_notification`, `schedule_message`, `get_notifications`, `search_memory`, `manage_skills`, `ask_user` |
105+
| **Run Python, a package manager or shell scripts** | The `:workspace` module installs a PRoot Linux rootfs and exposes `workspace_shell`, `workspace_read_file`, `workspace_write_file`, `workspace_edit_file` — no root required |
106+
| **Use custom MCP servers** | Built-in Model Context Protocol (MCP) client with SSE and Streamable-HTTP transports |
107+
| **Chat from laptop while phone does the work** | Embedded Ktor server + React Router SPA + JWT auth + SSE streaming, advertised over mDNS on the LAN |
108+
| **Read PDF / Word / Images and ask questions** | MuPDF engine, DOCX→Markdown parser, OCR transformer, image/audio attachments, multimodal vision models |
109+
54110
<div align="center">
55111

56112
<a href="https://github.com/smartworldarafath/Local-AI/issues"><picture><source media="(prefers-color-scheme: dark)" srcset="assets/readme/dark/btn-issues.svg"><img src="assets/readme/light/btn-issues.svg" alt="Report an issue" height="50"></picture></a>
@@ -73,6 +129,31 @@ All conversations, API keys, documents, vector embeddings, and tool executions r
73129

74130
</div>
75131

132+
<h3 id="showcase"><picture><source media="(prefers-color-scheme: dark) and (max-width: 640px)" srcset="assets/readme/dark/hm-overview.svg"><source media="(prefers-color-scheme: dark)" srcset="assets/readme/dark/h-overview.svg"><source media="(max-width: 640px)" srcset="assets/readme/light/hm-overview.svg"><img src="assets/readme/light/h-overview.svg" alt="App Showcase & Screenshots" width="100%"></picture></h3>
133+
134+
<div align="center">
135+
136+
<table>
137+
<tr>
138+
<td align="center" width="33%">
139+
<img src="docs/1.4.3_chat.jpg" alt="Chat with tools and reasoning" width="240" /><br/>
140+
<sub><b>Chat</b> — reasoning timer, tool badges, rendered SVG answer</sub>
141+
</td>
142+
<td align="center" width="33%">
143+
<img src="docs/1.4.3_memory.jpg" alt="Memory settings" width="240" /><br/>
144+
<sub><b>Memory</b> — memory modes, RAG retrieval, memory search tool</sub>
145+
</td>
146+
<td align="center" width="33%">
147+
<img src="docs/1.4.3_stats.jpg" alt="Statistics" width="240" /><br/>
148+
<sub><b>Statistics</b> — activity heatmap, conversations, tokens</sub>
149+
</td>
150+
</tr>
151+
</table>
152+
153+
<sub>More walkthroughs and animated setup demos are in [`docs/`](docs), including <code>1.1.6_providers_use.gif</code> and <code>1.3.4_providers_use.gif</code>.</sub>
154+
155+
</div>
156+
76157
<h3 id="hardware"><picture><source media="(prefers-color-scheme: dark) and (max-width: 640px)" srcset="assets/readme/dark/hm-hardware.svg"><source media="(prefers-color-scheme: dark)" srcset="assets/readme/dark/h-hardware.svg"><source media="(max-width: 640px)" srcset="assets/readme/light/hm-hardware.svg"><img src="assets/readme/light/h-hardware.svg" alt="Hardware & Performance: Real-time CPU/GPU monitor, power limit sliders & 120Hz display timing" width="100%"></picture></h3>
77158

78159
Local AI includes an embedded low-overhead hardware telemetry engine and custom power-budget controls located under **Settings ➔ Advanced Settings**:

‎assets/readme/dark/badge-multimodal.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎assets/readme/dark/card-hardware.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎assets/readme/dark/card-multimodal.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎assets/readme/dark/card-privacy.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎assets/readme/dark/card-rag.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎assets/readme/dark/card-redotpay.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎assets/readme/dark/card-sponsors.svg‎

Lines changed: 1 addition & 1 deletion
Loading

‎assets/readme/dark/h-architecture.svg‎

Lines changed: 2 additions & 2 deletions
Loading

‎assets/readme/dark/h-features.svg‎

Lines changed: 1 addition & 1 deletion
Loading

0 commit comments

Comments
 (0)