Skip to content

Commit 5501c0a

Browse files
committed
voxd logo & icon
1 parent cd6ad30 commit 5501c0a

File tree

3 files changed

+46
-7
lines changed

3 files changed

+46
-7
lines changed

ASSETS_LICENSE

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Copyright (c) 2025 Jakov Ivkovic. All Rights Reserved.
2+
3+
Scope: The VOXD wordmark and logo files in `src/voxd/assets/`.
4+
5+
Permission is granted to freely redistribute the VOXD logo UNMODIFIED, for any purpose
6+
(including commercial), and to bundle it with this project in packages, mirrors,
7+
CDNs, app stores, and reviews.
8+
9+
You may not:
10+
- Modify, recolor, or create derivative logos.
11+
- Use the logo or the VOXD name in a way that suggests endorsement or affiliation.
12+
- Use the logo as branding for your own product or service.
13+
14+
Trademark: VOXD and the VOXD logo are trademarks of Jakov Ivkovic. This license does
15+
not grant trademark rights beyond the permissions above.
16+
17+

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
# VOXD - Voice-Type / dictation app for Linux 🗣️⌨️
2+
<div align="center">
3+
<img src="src/voxd/assets/voxd-1.png" alt="VOXD logo" width="50%" />
4+
</div>
25

36
Running in background, provides fast **voice-to-text typing** in any Linux app.
4-
Using **LOCAL** voice processing, with optional **LOCAL** AI text post-processing.
7+
Using <span style="color:#FFD600">**LOCAL**</span> (offline) voice processing, with optional <span style="color:#FFD600">**LOCAL**</span> (offline) AI text post-processing.
58
Runs fine even on older CPUs. No GPU required.
69

7-
Hit your **hotkey shortcut** -> speak -> hotkey again -> watch your words appear wherever the cursor currently is, even AI-rewritten as a poem or a C++ code.
10+
Hit your <span style="color:#FFD600">**hotkey shortcut**</span> -> speak -> hotkey again -> watch your words appear wherever the cursor currently is, even AI-rewritten as a poem or a C++ code.
811

912
**Tested & Works on:**
1013
- Ubuntu 24.04 / GNOME
1114
- Ubuntu 25.04 / Sway
1215
- Fedora 42 / KDE
1316
- Arch / Hyprland
14-
- Pop!_OS 22
17+
- Omarchy 3.0
18+
- Pop!_OS 22 / COSMIC
1519
- Mint 22 / Cinnamon
1620
- openSUSE, Leap 15.6
1721

@@ -27,10 +31,11 @@ Hit your **hotkey shortcut** -> speak -> hotkey again -> watch your words appear
2731
| **Multiple UI** surfaces | CLI, GUI (minimal PyQt6), TRAY (system tray), FLUX (triggered by voice activity detection, beta) |
2832
| **Logging** & **performance** | Session log plus your own optional local performance data (CSV). |
2933

34+
3035

3136
## Setup
3237

33-
Complete the 2 steps: **Install VOXD** & **setup a hotkey**.
38+
Complete the 2 steps: <span style="color:#FFD600">**Install VOXD**</span> & <span style="color:#FFD600">**setup a hotkey**</span>.
3439

3540
### 1. Install VOXD
3641

@@ -104,10 +109,11 @@ b. **The command** to assign to the shortcut hotkey (EXACTLY as given):
104109

105110
c. Click **Add / Save**.
106111

107-
First, run the app in terminal (see below) with a global `voxd` command.
112+
First, run the app in terminal via just
113+
`voxd` or `voxd --setup` command.
108114
The first run will do some initial setup (voice model, LLM model for AIPP, ydotool user setup).
109115

110-
### <span style="color: #FFD600;">READY! → Go type anywhere with your voice!</span>
116+
### <span style="color:#FFD600">READY! → Go type anywhere with your voice!</span>
111117

112118

113119
---
@@ -336,7 +342,7 @@ audio_input_device: "pulse" # or a specific device name or index
336342

337343
## 📜 License & Credits
338344

339-
* VOXD – © 2025 Jakov Ivkovic – **MIT** license (see [`LICENSE`](LICENSE)).
345+
* VOXD – © 2025 Jakov Ivkovic – **MIT** license (see [`LICENSE`](LICENSE)). Logo and brand assets: see [`ASSETS_LICENSE`](ASSETS_LICENSE). Trademarks: see [`TRADEMARKS.md`](TRADEMARKS.md).
340346
* Speech engine powered by [**ggml-org/whisper.cpp**](https://github.com/ggml-org/whisper.cpp) (MIT) and OpenAI Whisper models (MIT).
341347
* Auto-typing/pasting powered by [**ReimuNotMoe/ydotool**](https://github.com/ReimuNotMoe/ydotool) (AGPLv3).
342348
* Transcript post-processing powered by [**ggml-org/llama.cpp**](https://github.com/ggml-org/llama.cpp) (MIT)

TRADEMARKS.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# VOXD Trademark Policy
2+
3+
VOXD™ and the VOXD logo are trademarks of Jakov Ivkovic.
4+
5+
Permitted without asking:
6+
- Use the word “VOXD” to refer to this project.
7+
- Redistribute the official VOXD logo unmodified when bundling this project (see `ASSETS_LICENSE`).
8+
9+
Not permitted without written permission:
10+
- Modify or create derivative versions of the VOXD logo.
11+
- Use the VOXD name or logo in a way that implies endorsement or affiliation.
12+
- Use the VOXD logo as branding for another product or service.
13+
14+
For permissions or questions, contact: [email protected]
15+
16+

0 commit comments

Comments
 (0)