Skip to content

Commit 372ce3b

Browse files
committed
docs: use custom confitty divider images
- replace generic hr elements with custom confittydivider.svg - adds visual branding throughout README - maintains consistent spacing and visual hierarchy
1 parent b31d8a9 commit 372ce3b

1 file changed

Lines changed: 48 additions & 2 deletions

File tree

README.md

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,11 +119,57 @@ This approach:
119119

120120
The exported file includes a header with generation date, config path, and reload shortcut reminder.
121121

122+
<div align="center">
123+
<img src="src/assets/confittydivider.svg" alt="divider" width="100%">
124+
</div>
125+
126+
## 🚀 Quick Start
127+
128+
### Using Confitty
129+
130+
1. **Open** [confitty.app](https://confitty.app) (or run locally)
131+
2. **Navigate** using the sidebar to explore config categories
132+
3. **Customize** settings – preview updates instantly
133+
4. **Review** raw output in the **Config** tab
134+
5. **Export** your `kitty.conf` file
135+
136+
### Applying Your Config
137+
138+
```bash
139+
# Save to Kitty config directory
140+
mkdir -p ~/.config/kitty
141+
cp kitty.conf ~/.config/kitty/
142+
143+
# Reload Kitty without restarting
144+
# Press: Ctrl+Shift+F5
145+
```
146+
147+
> **Note:** If you've remapped the reload shortcut, use your custom binding. See [Kitty keyboard shortcuts](https://sw.kovidgoyal.net/kitty/actions/).
148+
149+
### 📥 Importing Existing Configs
150+
151+
Click **Import** and select your `kitty.conf`. Confitty parses it and populates the visual editor.
152+
153+
Complex configs (custom kittens, include directives, environment variables) are preserved in the output even if they don't map to visual controls.
154+
155+
## ⚙️ How It Works
156+
157+
Confitty uses a **smart diff algorithm** that exports only settings that differ from Kitty's defaults:
158+
159+
- **Change font size** from 11 to 14? → Output includes `font_size 14`
160+
- **Leave it at 11?** → Not included in output
161+
162+
This approach:
163+
- ✅ Keeps configs readable and minimal
164+
- ✅ Avoids overriding defaults that may change between Kitty versions
165+
- ✅ Makes it easy to see what you've customized
166+
167+
The exported file includes a header with generation date, config path, and reload shortcut reminder.
168+
122169
---
123170

124171
<div align="center">
125-
<hr>
126-
<h2>� Development</h2>
172+
<h2> Development</h2>
127173
</div>
128174

129175
### Prerequisites

0 commit comments

Comments
 (0)