33</p >
44<h2 ></h2 > <!-- add a separating line -->
55<p align =" center " >
6- A system information fetch tool (or neofetch-like program) , which its focus point is the performance and <b>customizability</b>
6+ A modular information fetching ( neofetch-like) tool , which its focus point is the performance and <b>customizability</b>
77</p >
88
99<p align =" center " >
3434
3535## Key Features
3636* Run customfetch as a ** terminal** or ** GTK3 application** or even as an [ android widget] ( https://github.com/Toni500github/customfetch-android-app )
37- * Really easy to customize (check [ Config (with explanation) ] ( #config-with-explanation ) section )
38- * Fast (maybe) as [ fastfetch ] ( https://github.com/fastfetch-cli/fastfetch )
37+ * Really easy to [ customize ] ( #How-to-customize )
38+ * Incredibly extensible information fetchings via external plugins
3939* Super lightweight, 3.3MB max (GTK3 application)
4040
4141# Dependencies
@@ -73,7 +73,7 @@ yay -S customfetch-gui-bin
7373
7474## General Distros (Manual installation)
7575Download the latest ` .tar.gz ` tarball file in [ releases] ( https://github.com/Toni500github/customfetch/releases/latest ) \
76- It contains the ` /usr ` directory where you'll install it in your distro. Useful for package managers too
76+ It contains the ` /usr ` directory where you'll install it in your distro. Useful for package managers too.
7777
7878## Arch and based (AUR) (source)
7979``` bash
@@ -96,7 +96,7 @@ yay -S customfetch-gui-git
9696## Compile from (source) (unstable)
9797``` bash
9898# clone the git dir
99- git clone https://github.com/Toni500github/customfetch
99+ git clone --depth=1 https://github.com/Toni500github/customfetch
100100cd customfetch
101101
102102# DEBUG=0 for release build
@@ -107,7 +107,7 @@ make install DEBUG=0 GUI_APP=0
107107customfetch
108108```
109109
110- ## Config (with explanation)
110+ ## How to customize
111111
112112Read the manual ` customfetch.1 ` or execute customfetch with the arg ` -w ` for knowing more about the configuration in customfetch.\
113113This is only an explaination about tags and preview, that can be always found in the documentation.
@@ -122,45 +122,45 @@ Here's an example using my config
122122# The array for displaying the system infos
123123layout = [
124124 " $<title>" ,
125- " $<title_sep >" ,
125+ " $<title.sep >" ,
126126 " ${auto}OS: $<os.name> $<system.arch>" ,
127127 " ${auto}Host: $<system.host>" ,
128128 " ${auto}Kernel: $<os.kernel>" ,
129129 " ${auto}Uptime: $<os.uptime>" ,
130130 " ${auto}Terminal: $<user.terminal>" ,
131131 " ${auto}Shell: $<user.shell>" ,
132132 " ${auto}Packages: $<os.pkgs>" ,
133- " ${auto}Theme: $<theme- gtk- all.name>" ,
134- " ${auto}Icons: $<theme- gtk- all.icons>" ,
135- " ${auto}Font: $<theme- gtk- all.font>" ,
133+ " ${auto}Theme: $<theme. gtk. all.name>" ,
134+ " ${auto}Icons: $<theme. gtk. all.icons>" ,
135+ " ${auto}Font: $<theme. gtk. all.font>" ,
136136 " ${auto}Cursor: $<theme.cursor>" ,
137- " ${auto}WM: $<user.wm_name > $<user.wm_version >" ,
138- " ${auto}DE: $<user.de_name > $<user.de_version >" ,
137+ " ${auto}WM: $<user.wm.name > $<user.wm.version >" ,
138+ " ${auto}DE: $<user.de.name > $<user.de.version >" ,
139139 " $<auto.disk>" ,
140140 " ${auto}Swap: $<swap>" ,
141141 " ${auto}CPU: $<cpu>" ,
142142 " ${auto}GPU: $<gpu>" ,
143143 " ${auto}RAM: $<ram>" ,
144144 " " ,
145145 " $<colors>" , # normal colors palette
146- " $<colors_light >" # light colors palette
146+ " $<colors.light >" # light colors palette
147147]
148148
149149
150150```
151151
152152In the config we got an array variable called "layout". That's the variable where you customize how the infos should be displayed.\
153153There are 5 tags:
154- * ` $<module.member > ` - Used for printing the system info value of a member of a module .
155- * ` ${color} ` - Used for displaying text in a specific color.
154+ * ` $<info.module > ` - Used for printing the value of a module or its submembers .
155+ * ` ${color} ` - Used for displaying text in a specific color after it .
156156* ` $(bash command) ` - Used to execute bash commands and print the output.
157157* ` $[something,equalToSomethingElse,iftrue,ifalse] ` - Conditional tag to display different outputs based on the comparison.
158158* ` $%n1,n2% ` - Used to print the percentage and print with colors
159159
160160They can be used in the ascii art text file and layout, but how to use them?
161161
162- * ** The info tag (` $<> ` )** will print a value of a member of a module\
163- e.g ` $<user.name> ` will print the username, ` $<os.kernel_version > ` will print the kernel version and so on.\
162+ * ** The info tag (` $<> ` )** will print a value of a member of a module. \
163+ e.g ` $<user.name> ` will print the username, ` $<os.kernel.version > ` will print the kernel version and so on.\
164164 All the modules and their members are listed in the ` --list-modules ` argument
165165
166166* ** The bash command tag (` $() ` )** let's you execute bash commands and print the output\
@@ -214,8 +214,8 @@ They can be used in the ascii art text file and layout, but how to use them?
214214
215215Any ` $ ` or brackets can be escaped with a backslash ` \ ` . You need to escape backslashes too :(\
216216** NOTE:** For having compatibility with the GUI app, you need to escape ` < ` (EXCEPT if you are using in a info tag, like ` $<os.name> ` ) and ` & ` \
217- e.g ` the number 50 is \< than 100 \& 98 `
218- Won't affect the printing in terminal
217+ e.g ` the number 50 is \\ < than 100 \\&\ \& 98 `
218+ Won't affect the printing in terminal.
219219
220220## Star History
221221
@@ -228,8 +228,8 @@ Won't affect the printing in terminal
228228</a >
229229
230230# TODOs
231- * ~~ release v1 .0.0~~
232- Empty so far!
231+ * release v2 .0.0
232+ * work on the android app (later)
233233
234234# Thanks
235235I would like to thanks:
0 commit comments