Skip to content

Commit 613b257

Browse files
Update README.md
1 parent 5cbeeae commit 613b257

File tree

1 file changed

+40
-18
lines changed

1 file changed

+40
-18
lines changed

README.md

Lines changed: 40 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,11 @@ Currently supports Linux distros only. Android may be coming when stable release
4141
>To check if it's enabled or not, run "cufetch --version"
4242
4343
## Depends
44-
currently there aren't any dependencies to install, other than having `libdl` installed.\
45-
If you want to install with GUI mode install: `gtk3` and `gtkmm3` from your package manager
44+
* `libdl`
45+
46+
If you want to install with GUI mode install from your package manager:
47+
* `gtk3`
48+
* `gtkmm3`
4649

4750
## Installation
4851

@@ -132,14 +135,23 @@ source-path = "os"
132135

133136
# Path to where we'll take all the distros/OSs ascii arts
134137
# note: it MUST contain an "ascii" subdirectory
135-
data-dir = "~/customfetch/assets"
138+
data-dir = "/usr/share/customfetch"
139+
140+
# The type of ASCII art to apply ("small", "old").
141+
# Basically will add "_<type>" to the logo filename.
142+
# It will return the regular linux ascii art if it doesn't exist.
143+
# Leave empty it for regular.
144+
ascii-logo-type = ""
145+
146+
# A char (or string) to use in $<user.title_sep>
147+
sep-title = "-"
136148

137-
# A separetor (string) that when ecountered, will automatically
149+
# A separetor (or string) that when ecountered, will automatically
138150
# reset color, aka. automatically add ${0} (only in layout)
139151
# Make it empty for disabling
140152
sep-reset = ":"
141153

142-
# Offset between the ascii art and the system infos
154+
# Offset between the ascii art and the layout
143155
offset = 5
144156

145157
# Padding between the start and the ascii art
@@ -154,35 +166,45 @@ layout-padding-top = 0
154166
# Colors can be with: hexcodes (#55ff88) and for bold put '!' (!#55ff88)
155167
# OR ANSI escape code colors like "\e[1;34m"
156168
# remember to add ${0} where you want to reset color
157-
black = "\e[1;30m"
158-
red = "\e[1;31m"
159-
green = "\e[1;32m"
160-
yellow = "\e[1;33m"
161-
blue = "\e[1;34m"
169+
black = "\e[1;30m"
170+
red = "\e[1;31m"
171+
green = "\e[1;32m"
172+
yellow = "\e[1;33m"
173+
blue = "\e[1;34m"
162174
magenta = "\e[1;35m"
163-
cyan = "\e[1;36m"
164-
white = "\e[1;37m"
175+
cyan = "\e[1;36m"
176+
white = "\e[1;37m"
165177

166-
# $<os.uptime> config
178+
# $<os.uptime> config
167179
[os.uptime]
168180
# how to display the name of the uptime
169-
# e.g: hours = "h" -> "Uptime: 3h"
170-
days = " days"
181+
# e.g: hours = "hrs" -> "Uptime: 3hrs"
182+
days = " days"
171183
hours = " hours"
172-
mins = " mins"
173-
secs = " seconds"
184+
mins = " mins"
185+
secs = " seconds"
174186

175187
# $<os.pkgs> config
176188
[os.pkgs]
177189
# Ordered list of which packages installed count should be displayed in $<os.pkgs>
178190
# remember to not enter the same name twice, else the world will finish
179-
# Choices: pacman, flatpak, dpkg
191+
# Choices: pacman, flatpak, dpkg, apk
180192
#
181193
# Pro-tip: if your package manager isnt listed here, yet,
182194
# use the bash command component in the layout
183195
# e.g "Packages: $(pacman -Q | wc -l) (pacman)"
184196
pkg-managers = ["pacman", "dpkg", "flatpak"]
185197

198+
# Distros and package manager specific
199+
# package manager paths for getting the packages count from path.
200+
# They are arrayies so you can add multiple paths.
201+
#
202+
# If you don't know what these ares, leave them by default settings
203+
pacman-dirs = ["/var/lib/pacman/local/"]
204+
dpkg-files = ["/var/lib/dpkg/status"]
205+
flatpak-dirs = ["/var/lib/flatpak/app/", "~/.local/share/flatpak/app/"]
206+
apk-files = ["/var/lib/apk/db/installed"]
207+
186208
# GUI options
187209
# note: customfetch needs to be compiled with GUI_MODE=1 (check with "cufetch --version")
188210
[gui]

0 commit comments

Comments
 (0)