INSTALL.md (6043B)
1 # Doomsday Extension Installation Guide
2
3 ## Table of Contents
4
5 - [Quick Installation (Recommended)](#quick-installation-recommended)
6 - [Manual Installation](#manual-installation)
7 - [Installation from Source](#installation-from-source)
8 - [Troubleshooting](#troubleshooting)
9 - [Uninstallation](#uninstallation)
10
11 ---
12
13 ## Quick Installation (Recommended)
14
15 The easiest way to install Doomsday extension.
16
17 ### Prerequisites
18
19 - GNOME Shell 45, 46, or 47
20 - Extension Manager app (recommended)
21
22 ### Steps
23
24 1. **Download the extension**
25
26 Download `doomsday@devastator-x.github.io.shell-extension.zip` from:
27 - [GitHub Releases](https://github.com/sqzer-x/doomsday/releases/latest)
28
29 2. **Install via Extension Manager**
30
31 ```bash
32 # If you don't have Extension Manager installed:
33 flatpak install flathub com.mattjakeman.ExtensionManager
34 ```
35
36 - Open Extension Manager
37 - Click "Install from file..." button
38 - Select the downloaded ZIP file
39 - The extension will be installed automatically
40
41 3. **Enable the extension**
42
43 - Toggle the switch in Extension Manager to enable Doomsday
44 - Or use command line:
45
46 ```bash
47 gnome-extensions enable doomsday@devastator-x.github.io
48 ```
49
50 4. **Restart GNOME Shell**
51
52 - **X11**: Press `Alt+F2`, type `r`, press `Enter`
53 - **Wayland**: Log out and log back in
54
55 ---
56
57 ## Manual Installation
58
59 Install using command line.
60
61 ### Download and Install
62
63 ```bash
64 # 1. Download the extension
65 wget https://github.com/sqzer-x/doomsday/releases/latest/download/doomsday@devastator-x.github.io.shell-extension.zip
66
67 # 2. Create extension directory
68 mkdir -p ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io
69
70 # 3. Extract files
71 unzip doomsday@devastator-x.github.io.shell-extension.zip \
72 -d ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io
73
74 # 4. Compile schema
75 glib-compile-schemas \
76 ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io/schemas/
77
78 # 5. Enable extension
79 gnome-extensions enable doomsday@devastator-x.github.io
80
81 # 6. Restart GNOME Shell
82 # X11: Alt+F2, type 'r', press Enter
83 # Wayland: Log out and log back in
84 ```
85
86 ---
87
88 ## Installation from Source
89
90 Install directly from GitHub repository.
91
92 ### Clone Repository
93
94 ```bash
95 git clone https://github.com/sqzer-x/doomsday.git
96 cd doomsday
97 ```
98
99 ### Option 1: Using Installation Script
100
101 ```bash
102 # Run the installation script
103 ./install.sh
104 ```
105
106 The script will:
107 - Copy files to the extension directory
108 - Compile the GSettings schema
109 - Enable the extension
110
111 ### Option 2: Manual Installation from Source
112
113 ```bash
114 # Copy files to extension directory
115 cp -r . ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io
116
117 # Compile schema
118 glib-compile-schemas \
119 ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io/schemas/
120
121 # Enable extension
122 gnome-extensions enable doomsday@devastator-x.github.io
123 ```
124
125 ### Restart GNOME Shell
126
127 - **X11**: `Alt+F2` → type `r` → `Enter`
128 - **Wayland**: Log out and log back in
129
130 ---
131
132 ## Troubleshooting
133
134 ### Extension doesn't appear after installation
135
136 1. **Check if extension is enabled:**
137 ```bash
138 gnome-extensions list --enabled | grep doomsday
139 ```
140
141 2. **Check for errors:**
142 ```bash
143 journalctl -f -o cat /usr/bin/gnome-shell | grep -i doomsday
144 ```
145
146 3. **Restart GNOME Shell:**
147 - X11: `Alt+F2` → `r` → `Enter`
148 - Wayland: Log out and log back in
149
150 ### Schema compilation errors
151
152 ```bash
153 # Recompile schema manually
154 glib-compile-schemas \
155 ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io/schemas/
156 ```
157
158 ### Permission issues
159
160 ```bash
161 # Ensure correct ownership
162 chown -R $USER:$USER \
163 ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io
164
165 # Set correct permissions
166 chmod -R 755 \
167 ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io
168 ```
169
170 ### Extension appears but doesn't work
171
172 1. **Check GNOME Shell version compatibility:**
173 ```bash
174 gnome-shell --version
175 ```
176 Should be 45, 46, or 47
177
178 2. **Reinstall the extension:**
179 ```bash
180 gnome-extensions uninstall doomsday@devastator-x.github.io
181 # Then reinstall using one of the methods above
182 ```
183
184 ---
185
186 ## Uninstallation
187
188 ### Using Extension Manager
189
190 1. Open Extension Manager
191 2. Find "Doomsday" in the list
192 3. Click the uninstall button
193
194 ### Using Command Line
195
196 ```bash
197 # Disable and uninstall
198 gnome-extensions disable doomsday@devastator-x.github.io
199 gnome-extensions uninstall doomsday@devastator-x.github.io
200
201 # Remove settings (optional)
202 dconf reset -f /org/gnome/shell/extensions/doomsday/
203 ```
204
205 ### Manual Removal
206
207 ```bash
208 # Remove extension directory
209 rm -rf ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io
210
211 # Remove settings (optional)
212 dconf reset -f /org/gnome/shell/extensions/doomsday/
213
214 # Restart GNOME Shell
215 # X11: Alt+F2 → 'r' → Enter
216 # Wayland: Log out and log back in
217 ```
218
219 ---
220
221 ## Updating the Extension
222
223 ### From Extension Manager
224
225 Extension Manager will notify you when updates are available and handle updates automatically.
226
227 ### Manual Update
228
229 ```bash
230 # Download latest version
231 wget https://github.com/sqzer-x/doomsday/releases/latest/download/doomsday@devastator-x.github.io.shell-extension.zip
232
233 # Remove old version
234 rm -rf ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io
235
236 # Extract new version
237 mkdir -p ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io
238 unzip doomsday@devastator-x.github.io.shell-extension.zip \
239 -d ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io
240
241 # Compile schema
242 glib-compile-schemas \
243 ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io/schemas/
244
245 # Restart GNOME Shell
246 ```
247
248 ---
249
250 ## Getting Help
251
252 - **Issues**: https://github.com/sqzer-x/doomsday/issues
253 - **Documentation**: https://github.com/sqzer-x/doomsday
254 - **GNOME Extensions**: https://extensions.gnome.org
255
256 ---
257
258 **Note**: After installation, you may need to restart GNOME Shell for the extension to appear. On Wayland, this requires logging out and logging back in.