Pi66

walrs
pywal but if its Fast-Minimal-Simple
git clone https://git.pi66.xyz/walrs

← back to log

Potato

author: pixel2175
date: 2025-05-26 18:57
hash: 75cfcb56f5a800f61b1c23d7197207f855e72801

Diffstat:

M

README.md
125 ++++++++++--------------------
  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
diff --git a/README.md b/README.md
index 546c40d..e3c22e2 100644
--- a/README.md
+++ b/README.md
@@ -1,100 +1,59 @@
-# walrs: Fast Colorscheme Generator
+# Walrs
+pywal is its written in rust

-walrs is a fast color scheme generator written in Rust that creates terminal color schemes from images.
-
-[![Screenshot](screenshots/preview.gif)](screenshots/preview.gif)
-
----
-
-## Shortcuts
-- [Features](#features)
-- [Installation](#installation)
-- [Usage](#usage)
-- [Supported Terminals and Applications](#supported-terminals-and-applications)
-- [Performance](#performance)
-
----
-
-## Features
-- **Rust-based**: Fast and minimal resource usage
-- **Generate terminal color schemes** from images
-- **Reload themes instantly**
-- **Compatible with pywal templates**
-- **Seamless integration** with various terminal emulators and applications
-- **Specify the saturation and brightness value**
-
----
-
-## Installation
-### From AUR
-```bash
-yay -S walrs
-```
-
-### From Cargo
-```bash
-cargo install rswal
-```
-
-### From Source
-```bash
-git clone https://github.com/pixel2175/walrs.git
-cd walrs
-make install
-```
-The make install command will place all necessary files in their appropriate locations.
-
----
+## Features 
+- use the same as pywal do 
+- fast and minimal (10x faster than pywal)
+- better than wallust in colors, speed ,simplest
+- you can edit the brightness and saturation as you want 

 ## Usage
-
-Generate a color scheme from an image:
 ```bash
-walrs -i /path/to/image.jpg
-```
-
-Example output:
-```
-[I] Generate: generate colors.
-[I] Template: create templates.
-[I] Wallpaper: set the wallpaper.
-[I] Terminal: terminal colorscheme set.
-[I] Xrdb: xrdb colorscheme set.
-[I] Colors: colorscheme applied successfully.
-● ● ● ● ● ● ● ● ●
+walrs - Generate colorscheme from image
+
+Usage: walrs [OPTIONS]
+
+Options:
+  -i <IMAGE>                     path/to/your/wal.png | for random image: path/to/your/wallpapers/
+  -r, --reload-nowal             reload Templates with setting the wallpaper
+  -R, --reload                   reload Templates without setting the wallpaper
+  -t, --theme <THEME>            use external theme file
+  -g, --generate <GENERATE>      generate theme and save it in themes folder (.cache/wal/colorschemes)
+  -s, --saturation <SATURATION>  specify the saturation value -128 => 127
+  -b, --brightness <BRIGHTNESS>  specify the brightness value -128 => 127
+  -q, --quit                     set quit mode (no output)
+      --install-completions      Install completions for the current shell
+  -h, --help                     Print help
+  -V, --version                  Print version
 ```

----
-
-## Supported Terminals and Applications
-walrs is compatible with various terminals and applications through pywal templates:
-- sway
-- xrdb
-- tty
-- kitty
-- polybar
-- And more!
-
----
+## Installation
+- AUR
+```bash yay -S walrs```
+- Source
+```git clone https://github.com/pixel2175/walrs && make install```

 ## Performance
-walrs is designed to be lightweight and fast:
-- **Memory usage**: Approximately 3.9MB
-- **Processing time**: ~180-300ms to generate and apply a color scheme
-- **Dependencies**: Requires an external app to set wallpaper
+- **Memory** : 3mb 
+- **Time**   : 290ms for image 1.5mb 1080P image
+- **Dep**    : this app just requires an external app to set wallpaper (feh,xwallpaper,etc...)

-Example benchmark:
-```sh
-time walrs -i /path/to/image.{png, jpg, webp, etc...}
+### Benchmark
+```bash 
+time walrs -i ~/.config/wallpaper/
 [I] Generate: generate colors.
 [I] Template: create templates.
-[I] Wallpaper: set the wallpaper.
+[I] Wallpaper: wallpaper set with feh.
 [I] Terminal: terminal colorscheme set.
 [I] Xrdb: xrdb colorscheme set.
 [I] Colors: colorscheme applied successfully.
 ● ● ● ● ● ● ● ● ●
+
 ________________________________________________________
-Executed in  185.80 millis    fish           external
-   usr time  119.95 millis    0.56 millis  119.39 millis
-   sys time   58.95 millis    1.12 millis   57.82 millis
+Executed in  376.01 millis    fish           external
+   usr time  236.90 millis    2.05 millis  234.85 millis
+   sys time  132.21 millis    1.04 millis  131.17 millis
 ```
+
+
+- if you want any help catch me on discord @pi66