README.txt (4502B)
1 ================================================================================
2 Doomsday - GNOME Extension
3 D-Day Countdown Extension for GNOME Shell
4 ================================================================================
5
6 GNOME Version: 45, 46, 47
7 License: GPL-3.0
8
9 --------------------------------------------------------------------------------
10 Features
11 --------------------------------------------------------------------------------
12
13 ✓ D-Day Display in GNOME Panel
14 - Real-time countdown to important events on your panel
15
16 ✓ Multiple D-Day Management
17 - Unlimited events with easy add, edit, and delete
18
19 ✓ Quick Add/Edit/Delete
20 - Manage D-Days directly from extension menu without opening preferences
21
22 ✓ Event Selection
23 - Switch between events with a single click
24
25 ✓ Panel Position Customization
26 - Choose left, center, or right panel position
27
28 ✓ Automatic Updates
29 - Daily countdown refresh at midnight
30
31 --------------------------------------------------------------------------------
32 Installation
33 --------------------------------------------------------------------------------
34
35 [Method 1] Extension Manager (Recommended)
36
37 1. Open Extension Manager app
38 2. Click "Install from file..."
39 3. Select doomsday@devastator-x.github.io.shell-extension.zip
40 4. Enable the extension
41
42 [Method 2] Manual Installation
43
44 # Clone repository
45 git clone https://github.com/sqzer-x/doomsday.git
46 cd doomsday
47
48 # Run installation script
49 ./install.sh
50
51 # Restart GNOME Shell (Alt+F2, type 'r', press Enter)
52
53 [Method 3] Install from ZIP
54
55 # Extract to extension directory
56 mkdir -p ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io
57 unzip doomsday@devastator-x.github.io.shell-extension.zip \
58 -d ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io
59
60 # Compile schema
61 glib-compile-schemas \
62 ~/.local/share/gnome-shell/extensions/doomsday@devastator-x.github.io/schemas/
63
64 # Enable extension
65 gnome-extensions enable doomsday@devastator-x.github.io
66
67 # Restart GNOME Shell (Alt+F2, type 'r', press Enter)
68
69 --------------------------------------------------------------------------------
70 Usage
71 --------------------------------------------------------------------------------
72
73 [Adding D-Day]
74
75 1. Click D-Day on panel
76 2. Select "➕ Add D-Day"
77 3. Enter event name and date (YYYY-MM-DD format)
78 4. Click "Add"
79
80 [Editing/Deleting D-Day]
81
82 • From Menu: Click ✏️ (edit) or 🗑️ (delete) button next to each event
83 • From Settings: Click "⚙️ Manage Events" → Use Edit/Delete buttons
84
85 [Selecting D-Day to Display]
86
87 • Click on any D-Day in the menu (selected item marked with •)
88
89 [Changing Panel Position]
90
91 1. Click "⚙️ Manage Events"
92 2. Adjust position and index in "Panel Settings"
93
94 --------------------------------------------------------------------------------
95 Development
96 --------------------------------------------------------------------------------
97
98 # Install in development mode
99 git clone https://github.com/sqzer-x/doomsday.git
100 cd doomsday
101 ./install.sh
102
103 # View logs
104 journalctl -f -o cat /usr/bin/gnome-shell
105
106 # Restart extension (Alt+F2, type 'r', press Enter)
107
108 --------------------------------------------------------------------------------
109 File Structure
110 --------------------------------------------------------------------------------
111
112 doomsday@devastator-x.github.io/
113 ├── extension.js # Main extension logic
114 ├── prefs.js # Preferences UI
115 ├── metadata.json # Extension metadata
116 ├── stylesheet.css # Styles
117 ├── schemas/ # GSettings schema
118 │ └── org.gnome.shell.extensions.doomsday.gschema.xml
119 ├── install.sh # Installation script
120 └── README.txt # This file
121
122 --------------------------------------------------------------------------------
123 License
124 --------------------------------------------------------------------------------
125
126 GPL-3.0 License
127 See LICENSE file for details.
128
129 --------------------------------------------------------------------------------
130 Contributing
131 --------------------------------------------------------------------------------
132
133 Bug reports and feature requests welcome!
134 https://github.com/sqzer-x/doomsday/issues
135
136 --------------------------------------------------------------------------------
137
138 Made with ❤️ by sqzer-x
139 https://github.com/sqzer-x
140
141 ================================================================================