Skip to content

Commit 2337eac

Browse files
committed
edited readme
1 parent ff1db8c commit 2337eac

File tree

1 file changed

+14
-24
lines changed

1 file changed

+14
-24
lines changed

README.md

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,11 @@ LunarFetch can be configured using a JSON configuration file located at `~/.conf
110110
```
111111

112112
**Alternative styles:**
113+
113114
- Regular box: `"topLeft": "┌", "topRight": "┐", "bottomLeft": "└", "bottomRight": "┘"`
114115
- Rounded box (shown above): `"topLeft": "╭", "topRight": "╮", "bottomLeft": "╰", "bottomRight": "╯"`
115116
- Double line: `"topLeft": "╔", "topRight": "╗", "bottomLeft": "╚", "bottomRight": "╝", "topEdge": "═", "bottomEdge": "═", "leftEdge": "║", "rightEdge": "║"`
117+
116118
</details>
117119

118120
<details>
@@ -130,12 +132,14 @@ LunarFetch can be configured using a JSON configuration file located at `~/.conf
130132
```
131133

132134
**Options:**
135+
133136
- `enableLogo`: Enable/disable logo display (`true` or `false`)
134137
- `type`: Logo type (`"ascii"` or `"file"` to load from a file)
135138
- `content`: Custom ASCII content (when type is `"ascii"`)
136139
- `location`: Text alignment (`"center"`, `"left"`, or `"right"`)
137140
- `logoPath`: Directory containing logo files
138141
- `position`: Position relative to system info (`"side"` or `"above"`)
142+
139143
</details>
140144

141145
<details>
@@ -162,6 +166,7 @@ LunarFetch can be configured using a JSON configuration file located at `~/.conf
162166
```
163167

164168
**Options:**
169+
165170
- `enableImage`/`enabled`: Enable/disable image display (`true` or `false`)
166171
- `random`: Randomly select an image from the `imagePath` directory (`true` or `false`)
167172
- `imagePath`: Path to image file or directory (for random selection)
@@ -190,6 +195,7 @@ LunarFetch can be configured using a JSON configuration file located at `~/.conf
190195
- `offset`: Offset from terminal edge (integer)
191196
- `background`: Background color (`"transparent"` or a color value)
192197
- `position`: Position relative to system info (`"side"` or `"above"`)
198+
193199
</details>
194200

195201
<details>
@@ -203,10 +209,12 @@ LunarFetch can be configured using a JSON configuration file located at `~/.conf
203209
```
204210

205211
**Options:**
212+
206213
- `showLogoFirst`: When `true`, logo appears before system info
207214
- `showImageFirst`: When `true`, image appears before system info
208215

209216
Note: If both are `true`, logo takes precedence.
217+
210218
</details>
211219

212220
<details>
@@ -236,6 +244,7 @@ Note: If both are `true`, logo takes precedence.
236244
```
237245

238246
You can also use emoji instead of Nerd Font icons:
247+
239248
```json
240249
"icons": {
241250
"host": "🏠",
@@ -258,6 +267,7 @@ You can also use emoji instead of Nerd Font icons:
258267
"icons": "🔍"
259268
}
260269
```
270+
261271
</details>
262272

263273
<details>
@@ -287,6 +297,7 @@ You can also use emoji instead of Nerd Font icons:
287297
```
288298

289299
Set any option to `false` to hide that specific information.
300+
290301
</details>
291302

292303
### Example Configurations
@@ -316,6 +327,7 @@ Set any option to `false` to hide that specific information.
316327
}
317328
}
318329
```
330+
319331
</details>
320332

321333
<details>
@@ -352,6 +364,7 @@ Set any option to `false` to hide that specific information.
352364
}
353365
}
354366
```
367+
355368
</details>
356369

357370
<details>
@@ -441,6 +454,7 @@ Set any option to `false` to hide that specific information.
441454
}
442455
}
443456
```
457+
444458
</details>
445459

446460
## 🎨 Image Rendering and Dithering
@@ -458,35 +472,11 @@ LunarFetch supports various image rendering techniques to display images in your
458472
LunarFetch supports multiple protocols for rendering images in the terminal:
459473

460474
1. **Chafa**: The most compatible option that works in virtually any terminal. Chafa converts images to colored text characters.
461-
462475
2. **Sixel**: A graphics format supported by terminals like xterm with sixel extension, mlterm, and mintty.
463-
464476
3. **Kitty Graphics Protocol**: A modern protocol for displaying images in the Kitty terminal.
465-
466477
4. **iTerm2 Graphics Protocol**: For displaying images in iTerm2 on macOS.
467-
468478
5. **Uberzug**: A Linux-specific tool for displaying images in the terminal.
469479

470-
### Understanding Dithering
471-
472-
Dithering is a technique used in image processing to create the illusion of color depth in images with a limited color palette. LunarFetch implements the Floyd-Steinberg dithering algorithm, which works as follows:
473-
474-
1. **Color Reduction**: When displaying images in terminals with limited color capabilities, dithering helps maintain visual quality while reducing the number of colors used.
475-
476-
2. **Error Diffusion**: The algorithm processes each pixel, finds the closest available color, and distributes the error (difference) to neighboring pixels according to a specific pattern:
477-
```
478-
X 7/16
479-
3/16 5/16 1/16
480-
```
481-
Where X is the current pixel, and the fractions represent how much of the error is distributed to each neighboring pixel.
482-
483-
3. **Visual Benefits**: Dithering creates patterns of dots that, when viewed from a distance, appear to have more colors than are actually used. This is particularly useful for:
484-
- Smooth gradients
485-
- Detailed images
486-
- Photos with subtle color variations
487-
488-
To enable dithering, set `"ditherMode": "floyd-steinberg"` in your configuration.
489-
490480
## 🤝 Contributing
491481

492482
Contributions are welcome! Please feel free to submit a Pull Request.

0 commit comments

Comments
 (0)