Skip to content

Commit 24cb984

Browse files
ExposedCatExposedCat
committed
Update readme
1 parent a729aed commit 24cb984

File tree

3 files changed

+180
-163
lines changed

3 files changed

+180
-163
lines changed

‎README.md

Lines changed: 10 additions & 163 deletions
Original file line numberDiff line numberDiff line change
@@ -6,184 +6,31 @@
66

77
<div align="center">
88

9-
[![](https://img.shields.io/badge/My-Telegram-informational?style=for-the-badge&logo=telegram&logoColor=26A5E4&color=26A5E4)](https://t.me/ExposedCatDev)
10-
[![](https://img.shields.io/badge/My-Reddit-informational?style=for-the-badge&logo=reddit&logoColor=FF5700&color=FF5700)](https://www.reddit.com/user/ExposedCatDev)
9+
[![](https://img.shields.io/badge/author%20blog%20on-Telegram-informational?style=for-the-badge&logo=telegram&logoColor=26A5E4&color=26A5E4)](https://t.me/ExposedCatDev)
10+
[![](https://img.shields.io/badge/author-Reddit-informational?style=for-the-badge&logo=reddit&logoColor=FF5700&color=FF5700)](https://www.reddit.com/user/ExposedCatDev)
1111
</div>
1212

1313
<br>
1414
<h1>Installation</h1>
15-
<h2>GNOME Extensions website (recommended)</h2>
15+
<h2>GNOME website (recommended)</h2>
1616
<a href="https://extensions.gnome.org/extension/3921/snowy/">
17-
<img src="https://micheleg.github.io/dash-to-dock/media/get-it-on-ego.png" height="80">
17+
<!-- Button SVG by Just Perfection developer -->
18+
<img src="./download-from-ego.svg" height="80">
1819
</a>
1920
<h2>Build from source</h2>
20-
1. Download and build extension
21+
1. Download extension
2122
<pre language="bash">
2223
<code>git clone https://github.com/ExposedCat/snowy.git
23-
glib-compile-schemas snowy/schemas
2424
</code></pre>
2525
2. Add extension to system
2626
<pre language="bash">
2727
<code>mv snowy ~/.local/share/gnome-shell/extensions/snowy@exposedcat
2828
</code></pre>
29-
3. Logout and login again
30-
<h1>Configuration</h1>
31-
GUI settings are still in development (<b>contribution is highly appreciated</b>), but you can tweak nearly everything using <code>gsettings</code> command:<br>
29+
3. Build extension schemas
3230
<pre language="bash">
33-
gsettings --schemadir \
34-
~/.local/share/gnome-shell/extensions/snowy@exposedcat/schemas \
35-
set org.gnome.shell.extensions.snowy \
36-
GSKEY VALUE
37-
</pre>
38-
To see list of current settings values use following command:<br>
39-
<pre language="bash">
40-
gsettings --schemadir \
41-
~/.local/share/gnome-shell/extensions/snowy@exposedcat/schemas \
42-
list-recursively org.gnome.shell.extensions.snowy
43-
</pre>
44-
Here <code>GSKEY</code> is <b>GSettings Key</b> of setting and <code>VALUE</code> is setting value.<br>
45-
All available tweaks listed here:
46-
<br>
47-
<br>
48-
<table>
49-
<thead>
50-
<tr>
51-
<th>
52-
<em> Description </em>
53-
</th>
54-
<th>
55-
<em> GSettings Key </em>
56-
</th>
57-
<th>
58-
<em> Default value </em>
59-
</th>
60-
</tr>
61-
</thead>
62-
<tbody>
63-
<tr>
64-
<td>
65-
<div> Snowflake icons list </div>
66-
</td>
67-
<td>
68-
<code> flake-icons </code>
69-
</td>
70-
<td>
71-
<code> ❅,❆,❄ </code>
72-
</td>
73-
</tr>
74-
<tr>
75-
<td>
76-
<div> Minimal size of snowflake </div>
77-
</td>
78-
<td>
79-
<code> min-size </code>
80-
</td>
81-
<td>
82-
<code> 20 </code>
83-
</td>
84-
</tr>
85-
<tr>
86-
<td>
87-
<div> Minimal size of snowflake </div>
88-
</td>
89-
<td>
90-
<code> max-size </code>
91-
</td>
92-
<td>
93-
<code> 30 </code>
94-
</td>
95-
</tr>
96-
<tr>
97-
<td>
98-
<div> Snow falling interval in ms (less = higher drop rate) </div>
99-
</td>
100-
<td>
101-
<code> interval </code>
102-
</td>
103-
<td>
104-
<code> 2000 </code>
105-
</td>
106-
</tr>
107-
<tr>
108-
<td>
109-
<div> Minimal snowflakes number per one fall </div>
110-
</td>
111-
<td>
112-
<code> min-flakes </code>
113-
</td>
114-
<td>
115-
<code> 1 </code>
116-
</td>
117-
</tr>
118-
<tr>
119-
<td>
120-
<div> Maximal snowflakes number per one fall </div>
121-
</td>
122-
<td>
123-
<code> max-flakes </code>
124-
</td>
125-
<td>
126-
<code> 5 </code>
127-
</td>
128-
</tr>
129-
<tr>
130-
<td>
131-
<div> Minimal snowflakes falling duration (in ms) </div>
132-
</td>
133-
<td>
134-
<code> min-fall-duration </code>
135-
</td>
136-
<td>
137-
<code> 3000 </code>
138-
</td>
139-
</tr>
140-
<tr>
141-
<td>
142-
<div> Maximal snowflakes falling duration (in ms) </div>
143-
</td>
144-
<td>
145-
<code> max-fall-duration </code>
146-
</td>
147-
<td>
148-
<code> 6000 </code>
149-
</td>
150-
</tr>
151-
<tr>
152-
<td>
153-
<div> Minimal snowflakes rotation angle (in degrees) </div>
154-
</td>
155-
<td>
156-
<code> min-rotation-angle </code>
157-
</td>
158-
<td>
159-
<code> 15 </code>
160-
</td>
161-
</tr>
162-
<tr>
163-
<td>
164-
<div> Maximal snowflakes rotation angle (in degrees) </div>
165-
</td>
166-
<td>
167-
<code> max-rotation-angle </code>
168-
</td>
169-
<td>
170-
<code> 45 </code>
171-
</td>
172-
</tr>
173-
<tr>
174-
<td>
175-
<div> Maximal snowflakes number on the screen (max-flakes restriction). Re-enable extension to apply </div>
176-
</td>
177-
<td>
178-
<code> flakes-limit </code>
179-
</td>
180-
<td>
181-
<code> 30 </code>
182-
</td>
183-
</tr>
184-
</tbody>
185-
</table>
186-
<br>
31+
<code>export GSETTINGS_SCHEMA_DIR=~/.local/share/gnome-shell/extensions/snowy@exposedcat/schemas
32+
glib-compile-schemas ~/.local/share/gnome-shell/extensions/snowy@exposedcat/schemas</code></pre>
33+
4. Logout and login again
18734

18835
## License
18936

0 commit comments

Comments
 (0)