swadhin / veet public

docs: add custom vector SVG icons for all section headers and navigation links

swadhinbiswas committed 2 months ago

328056b

1 parent 0efec2e

commit 328056b

11 files changed

+142 -24

Files

assets

icons

compare.svg +12 config.svg +10 contribute.svg +13 license.svg +12 overview.svg +9 rocket.svg +14 search.svg +12 star.svg +11 theme.svg +13 trash.svg +12 README.md +24 -24

Showing 11 changed files+142-24

README.md assets/icons/compare.svg assets/icons/config.svg assets/icons/contribute.svg assets/icons/license.svg assets/icons/overview.svg assets/icons/rocket.svg assets/icons/search.svg assets/icons/star.svg assets/icons/theme.svg assets/icons/trash.svg

▼README.md

+24-24

@@ -2,7 +2,7 @@
2	2
3	3	<img src="assets/icons/icon.png" alt="VEET Logo" width="130" height="130"/>
4	4
5		-# VEET
	5	+
6	6
7	7	### Universal Linux Application Uninstaller & Deep-Clean Residual Purger
8	8
@@ -11,7 +11,7 @@
11	11	[![Go Reference](https://pkg.go.dev/badge/github.com/swadhinbiswas/veet.svg)](https://pkg.go.dev/github.com/swadhinbiswas/veet)
12	12	[![Go Version](https://img.shields.io/badge/Go-1.24+-00ADD8?style=flat-square&logo=go)](https://go.dev)
13	13	[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square)](LICENSE)
14		-[![Platform](https://img.shields.io/badge/Platform-Linux-FCC624?style=flat-square&logo=linux&logoColor=black)](#-technical-overview)
	14	+[![Platform](https://img.shields.io/badge/Platform-Linux-FCC624?style=flat-square&logo=linux&logoColor=black)](#technical-overview)
15	15	[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](CONTRIBUTING.md)
16	16
17	17	<p align="center">
@@ -20,15 +20,15 @@
20	20	</p>
21	21
22	22	<p align="center">
23		- <a href="#-technical-overview">Overview</a> •
24		- <a href="#-comparison-matrix">Comparison</a> •
25		- <a href="#-core-capabilities">Capabilities</a> •
26		- <a href="#-installation">Installation</a> •
27		- <a href="#-usage">Usage</a> •
28		- <a href="#-search-syntax">Search Syntax</a> •
29		- <a href="#-theming">Themes</a> •
30		- <a href="#-keybinding-reference">Keybindings</a> •
31		- <a href="#-configuration">Config</a>
	23	+ <a href="#technical-overview">Overview</a> •
	24	+ <a href="#comparison-matrix">Comparison</a> •
	25	+ <a href="#core-capabilities">Capabilities</a> •
	26	+ <a href="#installation">Installation</a> •
	27	+ <a href="#usage">Usage</a> •
	28	+ <a href="#search-syntax">Search Syntax</a> •
	29	+ <a href="#theming">Themes</a> •
	30	+ <a href="#keybinding-reference">Keybindings</a> •
	31	+ <a href="#configuration">Config</a>
32	32	</p>
33	33
34	34	<br/>
@@ -39,7 +39,7 @@
39	39
40	40	---
41	41
42		-## ⚡ Technical Overview
	42	+## <img src="assets/icons/overview.svg" alt="" width="22" height="22" align="center" /> Technical Overview
43	43
44	44	When software is uninstalled using conventional Linux package managers (`pacman -R`, `apt remove`, `dnf remove`, `flatpak uninstall`, `snap remove`), only package-managed system files (`/usr/bin`, `/usr/share`) are modified. User-space and container storage directories remain orphaned on disk:
45	45
@@ -57,7 +57,7 @@ Over time, unmanaged leftovers consume gigabytes of valuable storage. Modern Lin
57	57
58	58	---
59	59
60		-## 📊 Comparison Matrix
	60	+## <img src="assets/icons/compare.svg" alt="" width="22" height="22" align="center" /> Comparison Matrix
61	61
62	62	\| Feature \| `pacman -R` / `apt` \| `flatpak uninstall` \| `bleachbit` \| `veet` \|
63	63	\|:---\|:---:\|:---:\|:---:\|:---:\|
@@ -75,7 +75,7 @@ Over time, unmanaged leftovers consume gigabytes of valuable storage. Modern Lin
75	75
76	76	---
77	77
78		-## 🌟 Core Capabilities
	78	+## <img src="assets/icons/star.svg" alt="" width="22" height="22" align="center" /> Core Capabilities
79	79
80	80	<table>
81	81	<tr>
@@ -112,7 +112,7 @@ Over time, unmanaged leftovers consume gigabytes of valuable storage. Modern Lin
112	112
113	113	---
114	114
115		-## 📥 Installation
	115	+## <img src="assets/icons/install.svg" alt="" width="22" height="22" align="center" /> Installation
116	116
117	117	### Option 1: Arch Linux (AUR)
118	118
@@ -174,7 +174,7 @@ make install
174	174
175	175	---
176	176
177		-## 🚀 Usage
	177	+## <img src="assets/icons/rocket.svg" alt="" width="22" height="22" align="center" /> Usage
178	178
179	179	### Interactive Terminal Dashboard (TUI)
180	180
@@ -219,7 +219,7 @@ veet history --clear
219	219
220	220	---
221	221
222		-## 🔍 Search Syntax
	222	+## <img src="assets/icons/search.svg" alt="" width="22" height="22" align="center" /> Search Syntax
223	223
224	224	Press <kbd>/</kbd> in the TUI to focus the search bar. VEET supports powerful query modifiers:
225	225
@@ -236,7 +236,7 @@ Press <kbd>/</kbd> in the TUI to focus the search bar. VEET supports powerful qu
236	236
237	237	---
238	238
239		-## 🎨 Theming
	239	+## <img src="assets/icons/theme.svg" alt="" width="22" height="22" align="center" /> Theming
240	240
241	241	VEET features 7 hand-crafted color palettes to seamlessly integrate with your terminal setup. Configure your theme in `~/.config/veet/config.yaml`:
242	242
@@ -256,7 +256,7 @@ theme: catppuccin # Options: cyan, catppuccin, nord, dracula, gruvbox, tokyo-ni
256	256
257	257	---
258	258
259		-## ⌨️ Keybinding Reference
	259	+## <img src="assets/icons/keyboard.svg" alt="" width="22" height="22" align="center" /> Keybinding Reference
260	260
261	261	<table width="100%">
262	262	<thead>
@@ -347,12 +347,12 @@ theme: catppuccin # Options: cyan, catppuccin, nord, dracula, gruvbox, tokyo-ni
347	347
348	348	---
349	349
350		-## ⚙️ Configuration
	350	+## <img src="assets/icons/config.svg" alt="" width="22" height="22" align="center" /> Configuration
351	351
352	352	<details>
353	353	<summary><b>Custom Configuration (<code>~/.config/veet/config.yaml</code>)</b></summary>
354	354	<br/>
355		-
	355	+
356	356	VEET supports optional user configuration via YAML. Create `~/.config/veet/config.yaml` to customize your visual palette, icon rendering mode, and register protected components:
357	357
358	358	```yaml
@@ -399,7 +399,7 @@ veet/
399	399
400	400	---
401	401
402		-## 🗑️ Uninstallation
	402	+## <img src="assets/icons/trash.svg" alt="" width="22" height="22" align="center" /> Uninstallation
403	403
404	404	### From Cloned Source Repository
405	405	```bash
@@ -422,12 +422,12 @@ rm -rf ~/.local/share/veet ~/.config/veet
422	422
423	423	---
424	424
425		-## 🤝 Contributing
	425	+## <img src="assets/icons/contribute.svg" alt="" width="22" height="22" align="center" /> Contributing
426	426
427	427	Contributions are welcome! Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for local development setup, detector implementation guides, and testing protocols.
428	428
429	429	---
430	430
431		-## 📄 License
	431	+## <img src="assets/icons/license.svg" alt="" width="22" height="22" align="center" /> License
432	432
433	433	VEET is open-source software licensed under the [MIT License](LICENSE).
434	434

▼assets/icons/compare.svg

+12-0

@@ -0,0 +1,12 @@
	1	+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" fill="none">
	2	+ <defs>
	3	+ <linearGradient id="compGrad" x1="0%" y1="0%" x2="100%" y2="100%">
	4	+ <stop offset="0%" stop-color="#06B6D4" />
	5	+ <stop offset="100%" stop-color="#10B981" />
	6	+ </linearGradient>
	7	+ </defs>
	8	+ <line x1="18" y1="20" x2="18" y2="10" stroke="url(#compGrad)" stroke-width="2" stroke-linecap="round"/>
	9	+ <line x1="12" y1="20" x2="12" y2="4" stroke="url(#compGrad)" stroke-width="2" stroke-linecap="round"/>
	10	+ <line x1="6" y1="20" x2="6" y2="14" stroke="url(#compGrad)" stroke-width="2" stroke-linecap="round"/>
	11	+ <path d="M3 20H21" stroke="url(#compGrad)" stroke-width="2" stroke-linecap="round"/>
	12	+</svg>
0	13

▼assets/icons/config.svg

+10-0

@@ -0,0 +1,10 @@
	1	+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" fill="none">
	2	+ <defs>
	3	+ <linearGradient id="configGrad" x1="0%" y1="0%" x2="100%" y2="100%">
	4	+ <stop offset="0%" stop-color="#6366F1" />
	5	+ <stop offset="100%" stop-color="#A855F7" />
	6	+ </linearGradient>
	7	+ </defs>
	8	+ <circle cx="12" cy="12" r="3" stroke="url(#configGrad)" stroke-width="2"/>
	9	+ <path d="M19.4 15a1.65 1.65 0 0 0 .33 1.82l.06.06a2 2 0 0 1 0 2.83 2 2 0 0 1-2.83 0l-.06-.06a1.65 1.65 0 0 0-1.82-.33 1.65 1.65 0 0 0-1 1.51V21a2 2 0 0 1-2 2 2 2 0 0 1-2-2v-.09A1.65 1.65 0 0 0 9 19.4a1.65 1.65 0 0 0-1.82.33l-.06.06a2 2 0 0 1-2.83 0 2 2 0 0 1 0-2.83l.06-.06a1.65 1.65 0 0 0 .33-1.82 1.65 1.65 0 0 0-1.51-1H3a2 2 0 0 1-2-2 2 2 0 0 1 2-2h.09A1.65 1.65 0 0 0 4.6 9a1.65 1.65 0 0 0-.33-1.82l-.06-.06a2 2 0 0 1 0-2.83 2 2 0 0 1 2.83 0l.06.06a1.65 1.65 0 0 0 1.82.33H9a1.65 1.65 0 0 0 1-1.51V3a2 2 0 0 1 2-2 2 2 0 0 1 2 2v.09a1.65 1.65 0 0 0 1 1.51 1.65 1.65 0 0 0 1.82-.33l.06-.06a2 2 0 0 1 2.83 0 2 2 0 0 1 0 2.83l-.06.06a1.65 1.65 0 0 0-.33 1.82V9a1.65 1.65 0 0 0 1.51 1H21a2 2 0 0 1 2 2 2 2 0 0 1-2 2h-.09a1.65 1.65 0 0 0-1.51 1z" stroke="url(#configGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	10	+</svg>
0	11

▼assets/icons/contribute.svg

+13-0

@@ -0,0 +1,13 @@
	1	+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" fill="none">
	2	+ <defs>
	3	+ <linearGradient id="contribGrad" x1="0%" y1="0%" x2="100%" y2="100%">
	4	+ <stop offset="0%" stop-color="#10B981" />
	5	+ <stop offset="100%" stop-color="#06B6D4" />
	6	+ </linearGradient>
	7	+ </defs>
	8	+ <path d="M16 3H21V8" stroke="url(#contribGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	9	+ <path d="M4 20L21 3" stroke="url(#contribGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	10	+ <path d="M21 14V19C21 20.1 20.1 21 19 21H5C3.9 21 3 20.1 3 19V5C3 3.9 3.9 3 5 3H10" stroke="url(#contribGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	11	+ <path d="M11 14C11 12.34 12.34 11 14 11C15.66 11 17 12.34 17 14" stroke="url(#contribGrad)" stroke-width="2" stroke-linecap="round"/>
	12	+ <circle cx="14" cy="7" r="2" stroke="url(#contribGrad)" stroke-width="2"/>
	13	+</svg>
0	14

▼assets/icons/license.svg

+12-0

@@ -0,0 +1,12 @@
	1	+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" fill="none">
	2	+ <defs>
	3	+ <linearGradient id="licGrad" x1="0%" y1="0%" x2="100%" y2="100%">
	4	+ <stop offset="0%" stop-color="#3B82F6" />
	5	+ <stop offset="100%" stop-color="#6366F1" />
	6	+ </linearGradient>
	7	+ </defs>
	8	+ <path d="M14 2H6C4.9 2 4 2.9 4 4V20C4 21.1 4.9 22 6 22H18C19.1 22 20 21.1 20 20V8L14 2Z" stroke="url(#licGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	9	+ <path d="M14 2V8H20" stroke="url(#licGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	10	+ <line x1="8" y1="13" x2="16" y2="13" stroke="url(#licGrad)" stroke-width="2" stroke-linecap="round"/>
	11	+ <line x1="8" y1="17" x2="13" y2="17" stroke="url(#licGrad)" stroke-width="2" stroke-linecap="round"/>
	12	+</svg>
0	13

▼assets/icons/overview.svg

+9-0

@@ -0,0 +1,9 @@
	1	+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" fill="none">
	2	+ <defs>
	3	+ <linearGradient id="overGrad" x1="0%" y1="0%" x2="100%" y2="100%">
	4	+ <stop offset="0%" stop-color="#FBBF24" />
	5	+ <stop offset="100%" stop-color="#F59E0B" />
	6	+ </linearGradient>
	7	+ </defs>
	8	+ <polygon points="13 2 3 14 12 14 11 22 21 10 12 10 13 2" stroke="url(#overGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	9	+</svg>
0	10

▼assets/icons/rocket.svg

+14-0

@@ -0,0 +1,14 @@
	1	+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" fill="none">
	2	+ <defs>
	3	+ <linearGradient id="rocketGrad" x1="0%" y1="0%" x2="100%" y2="100%">
	4	+ <stop offset="0%" stop-color="#F59E0B" />
	5	+ <stop offset="100%" stop-color="#EF4444" />
	6	+ </linearGradient>
	7	+ </defs>
	8	+ <path d="M4.5 16.5C3 18 3 21 3 21C3 21 6 21 7.5 19.5L10.5 16.5L7.5 13.5L4.5 16.5Z" stroke="url(#rocketGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	9	+ <path d="M14.5 3.5C12 4 9 6.5 7.5 9.5L14.5 16.5C17.5 15 20 12 20.5 9.5C21 7 20 4.5 19.5 3.5C18.5 3 16 2 14.5 3.5Z" stroke="url(#rocketGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	10	+ <circle cx="15" cy="9" r="1.5" stroke="url(#rocketGrad)" stroke-width="1.5"/>
	11	+ <path d="M4 20L2 22" stroke="url(#rocketGrad)" stroke-width="2" stroke-linecap="round"/>
	12	+ <path d="M9 18L10 21" stroke="url(#rocketGrad)" stroke-width="2" stroke-linecap="round"/>
	13	+ <path d="M6 15L3 14" stroke="url(#rocketGrad)" stroke-width="2" stroke-linecap="round"/>
	14	+</svg>
0	15

▼assets/icons/search.svg

+12-0

@@ -0,0 +1,12 @@
	1	+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" fill="none">
	2	+ <defs>
	3	+ <linearGradient id="searchGrad" x1="0%" y1="0%" x2="100%" y2="100%">
	4	+ <stop offset="0%" stop-color="#06B6D4" />
	5	+ <stop offset="100%" stop-color="#3B82F6" />
	6	+ </linearGradient>
	7	+ </defs>
	8	+ <circle cx="11" cy="11" r="7" stroke="url(#searchGrad)" stroke-width="2"/>
	9	+ <path d="M16 16L21 21" stroke="url(#searchGrad)" stroke-width="2" stroke-linecap="round"/>
	10	+ <path d="M8 11H14" stroke="url(#searchGrad)" stroke-width="1.5" stroke-linecap="round"/>
	11	+ <path d="M11 8V14" stroke="url(#searchGrad)" stroke-width="1.5" stroke-linecap="round"/>
	12	+</svg>
0	13

▼assets/icons/star.svg

+11-0

@@ -0,0 +1,11 @@
	1	+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" fill="none">
	2	+ <defs>
	3	+ <linearGradient id="starGrad" x1="0%" y1="0%" x2="100%" y2="100%">
	4	+ <stop offset="0%" stop-color="#F59E0B" />
	5	+ <stop offset="100%" stop-color="#E11D48" />
	6	+ </linearGradient>
	7	+ </defs>
	8	+ <path d="M12 2L14.4 8.6L21 11L14.4 13.4L12 20L9.6 13.4L3 11L9.6 8.6L12 2Z" stroke="url(#starGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	9	+ <circle cx="19" cy="5" r="1.5" fill="url(#starGrad)"/>
	10	+ <circle cx="5" cy="19" r="1.5" fill="url(#starGrad)"/>
	11	+</svg>
0	12

▼assets/icons/theme.svg

+13-0

@@ -0,0 +1,13 @@
	1	+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" fill="none">
	2	+ <defs>
	3	+ <linearGradient id="themeGrad" x1="0%" y1="0%" x2="100%" y2="100%">
	4	+ <stop offset="0%" stop-color="#EC4899" />
	5	+ <stop offset="100%" stop-color="#8B5CF6" />
	6	+ </linearGradient>
	7	+ </defs>
	8	+ <path d="M12 2C6.48 2 2 6.48 2 12C2 17.52 6.48 22 12 22C13.66 22 15 20.66 15 19C15 18.23 14.69 17.53 14.19 17.02C13.69 16.51 13.38 15.82 13.38 15.05C13.38 13.39 14.73 12.04 16.39 12.04H18C20.21 12.04 22 10.25 22 8.04C22 4.7 17.52 2 12 2Z" stroke="url(#themeGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	9	+ <circle cx="6.5" cy="11.5" r="1.5" fill="url(#themeGrad)"/>
	10	+ <circle cx="9.5" cy="7.5" r="1.5" fill="url(#themeGrad)"/>
	11	+ <circle cx="14.5" cy="7.5" r="1.5" fill="url(#themeGrad)"/>
	12	+ <circle cx="17.5" cy="11.5" r="1.5" fill="url(#themeGrad)"/>
	13	+</svg>
0	14

▼assets/icons/trash.svg

+12-0

@@ -0,0 +1,12 @@
	1	+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" width="20" height="20" fill="none">
	2	+ <defs>
	3	+ <linearGradient id="trashGrad" x1="0%" y1="0%" x2="100%" y2="100%">
	4	+ <stop offset="0%" stop-color="#F43F5E" />
	5	+ <stop offset="100%" stop-color="#E11D48" />
	6	+ </linearGradient>
	7	+ </defs>
	8	+ <path d="M3 6H5H21" stroke="url(#trashGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	9	+ <path d="M8 6V4C8 3.45 8.45 3 9 3H15C15.55 3 16 3.45 16 4V6M19 6V20C19 21.1 18.1 22 17 22H7C5.9 22 5 21.1 5 20V6H19Z" stroke="url(#trashGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	10	+ <path d="M10 11V17" stroke="url(#trashGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	11	+ <path d="M14 11V17" stroke="url(#trashGrad)" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"/>
	12	+</svg>
0	13