Skip to content

Commit 419de0d

Browse files
committed
Update README
1 parent 7b74733 commit 419de0d

2 files changed

Lines changed: 60 additions & 9 deletions

File tree

README.md

Lines changed: 60 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,73 @@
1818

1919
---
2020

21-
Lightweight **Vala** + **GTK4** + **libadwaita** desktop client that talks to [deltachat-rpc-server](https://github.com/deltachat/deltachat-core-rust) over JSON-RPC. Follows GNOME HIG, works on desktop and mobile.
22-
23-
**Highlights:** adaptive split-view layout, message bubbles, file attachments with image previews, chat search, real-time delivery, end-to-end encryption via Autocrypt, and auto-discovery of existing Delta Chat accounts.
21+
Lightweight **Vala** + **GTK4** + **libadwaita** desktop client that talks to [deltachat-rpc-server](https://github.com/deltachat/deltachat-core-rust) over JSON-RPC. Follows GNOME HIG, works on desktop and mobile form factors.
22+
23+
## Features
24+
25+
### Messaging
26+
27+
- **Rich compose bar** — multi-line text, file attachments via picker or drag-and-drop, paste images or files straight from the clipboard.
28+
- **Reply, edit, delete, forward** — full message actions via right-click; delete-for-self or delete-for-everyone on your own messages.
29+
- **Emoji reactions** — quick-pick 👍 ❤️ 😂 😮 😢 👎 shown as badges on the message.
30+
- **Pinned messages** — pin any message in a chat; a pinned-messages bar at the top of the conversation lets you jump back to them.
31+
- **Reply previews** — quoted sender and text preview (capped at 3 lines) above the compose entry and inside bubbles.
32+
- **Inline image previews** with a full-screen viewer (click to open, right-click to save, Escape to close).
33+
- **Optional Markdown rendering****bold**, *italic*, ~~strikethrough~~, `inline code`, fenced code blocks, headings, and auto-linkified URLs.
34+
- **In-chat search** (Ctrl+F) with real-time filtering and highlight.
35+
- **Save attachments** to disk from the message context menu.
36+
37+
### Chats
38+
39+
- **Adaptive split-view** sidebar + conversation, collapsing to a single pane on narrow windows with a back button.
40+
- **Chat list** with avatars, unread dots and badges, last-message preview, smart timestamps (time / weekday / date), pinned indicator and muted styling.
41+
- **Pin, mute, delete** chats from the sidebar context menu; view chat info (members, avatar, type) in a dedicated dialog.
42+
- **Contact requests** surfaced with their own badge.
43+
- **Sidebar search** to filter chats by name.
44+
- **Quick switcher** fuzzy chat search, Enter to open the top match.
45+
- **New 1:1 chat** via contact picker, and **new group** with name, avatar and member selection.
46+
47+
### Accounts & profile
48+
49+
- **Auto-discovery** of existing Delta Chat accounts from Delta Chat Desktop, Flatpak, Snap and OpenClaw installations — no re-login needed.
50+
- **Auto-discovery of `deltachat-rpc-server`** from `$PATH`, `~/.local/bin`, pip user installs, virtualenvs, and Flatpak runtimes.
51+
- **Multi-account** switching from the settings dialog.
52+
- **My Profile** dialog to edit display name, status and avatar.
53+
- **End-to-end encryption** via Autocrypt, handled by the Delta Chat core.
54+
55+
### Settings
56+
57+
- Double-click action on a message: Reply / React ❤️ / React 👍 / Open profile / None.
58+
- Toggle Markdown rendering.
59+
- Toggle Shift+Enter vs Enter to send.
60+
- Toggle desktop notifications for incoming messages when the window is unfocused.
61+
62+
### Keyboard shortcuts
63+
64+
| Action | Shortcut |
65+
| --- | --- |
66+
| New chat | `Ctrl+N` |
67+
| New group | `Ctrl+G` |
68+
| Quick chat switcher | `Ctrl+K` |
69+
| Search in conversation | `Ctrl+F` |
70+
| Focus compose entry | `Ctrl+L` |
71+
| Refresh | `Ctrl+R` |
72+
| Settings | `Ctrl+,` |
73+
| Close window | `Ctrl+W` |
74+
| Quit | `Ctrl+Q` |
75+
| Close dialog / viewer / search | `Esc` |
2476

2577
## Build
2678

2779
```sh
28-
# Install dependencies (Debian/Ubuntu)
80+
# Install dependencies (Ubuntu)
2981
sudo apt install valac meson libgtk-4-dev libadwaita-1-dev libjson-glib-dev
3082

3183
# Install the RPC backend
3284
pip install deltachat-rpc-server
3385

3486
# Build & run
35-
meson setup builddir && meson compile -C builddir
36-
./builddir/deltachat-gnome
87+
make ; make run
3788
```
3889

3990
<details>
@@ -42,13 +93,13 @@ meson setup builddir && meson compile -C builddir
4293
**Fedora:** `sudo dnf install vala meson gtk4-devel libadwaita-devel json-glib-devel`
4394

4495
**Arch:** `sudo pacman -S vala meson gtk4 libadwaita json-glib`
45-
</details>
4696

47-
The app auto-discovers `deltachat-rpc-server` from `$PATH`, `~/.local/bin`, virtualenvs, or Flatpak, and picks up existing accounts from Delta Chat Desktop or OpenClaw configurations.
97+
**FlatPak:** `flatpak install org.deltachat.Gnome.flatpak`
98+
</details>
4899

49100
## Contributing
50101

51-
Early-stage project &mdash; contributions welcome! Open areas: group chat creation, settings UI, notifications, Flatpak packaging, keyboard shortcuts.
102+
Early-stage project &mdash; contributions welcome! Open areas: Flatpak packaging, theming, richer notifications, accessibility polish, and more message types.
52103

53104
## License
54105

about.png

26.3 KB
Loading

0 commit comments

Comments
 (0)