Skip to content

Commit a367d63

Browse files
committed
Add more explicit inkscape dependency to readme and errors
1 parent 5bdb91b commit a367d63

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,18 @@ not get deleted, as the main script `matter.py` is needed for future grub
3535
updates made by your system. Also if you wan't to uninstall matter you should do
3636
it from there as well.
3737

38+
## Dependencies
39+
40+
Matter will inform you of any missing dependencies, but here is a list anyways:
41+
42+
- `inkscape` (**Main dependency**): This brings the `convert` command from
43+
`imagemagick` with best svg to png conversion.
44+
- `update-grub`, `grub-mkconfig`, and `grub-mkfont`: General grub utilities
45+
needed, if you don't have these, please create an issue with more information
46+
about your system as I've only worked on systems that have these commands.
47+
- `grub2-theme-preview` (Optional): For testing results (`--test/-t` argument)
48+
without rebooting.
49+
3850
# Usage
3951

4052
## Help

matter.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,10 @@ def is_icon_downloaded(icon_name):
219219

220220
def convert_icon_svg2png(icon_name):
221221
if not has_command("convert"):
222-
error("Stop. The convert command from imagemagick was not found")
222+
error(
223+
"Stop. The `convert` command from imagemagick was not found",
224+
"Consider installing `inkscape`",
225+
)
223226
if not has_command("inkscape"):
224227
warning("Resulting icons could look a bit off, consider installing inkscape")
225228
color = (

0 commit comments

Comments
 (0)