86 lines
2.3 KiB
Markdown
86 lines
2.3 KiB
Markdown
# Deskmeter GNOME Integration - Documentation
|
|
|
|
Complete documentation for the Deskmeter GNOME task display tools.
|
|
|
|
## Documentation Files
|
|
|
|
### Getting Started
|
|
|
|
**[READY_TO_TEST.md](READY_TO_TEST.md)** - ⭐ START HERE
|
|
Complete testing guide with checklists, troubleshooting, and commands. Everything you need to test both the task window and GNOME extension.
|
|
|
|
### Task Window
|
|
|
|
**[TASK_WINDOW_README.md](TASK_WINDOW_README.md)**
|
|
Detailed guide for the standalone GTK task window:
|
|
- Usage instructions
|
|
- Configuration options
|
|
- Startup and autostart setup
|
|
- Comparison with extension
|
|
|
|
### GNOME Extension
|
|
|
|
**[INSTALL_STATUS.md](INSTALL_STATUS.md)**
|
|
Extension installation status and troubleshooting:
|
|
- Installation checklist
|
|
- Wayland requirements
|
|
- Detailed troubleshooting steps
|
|
- GNOME Looking Glass debugging
|
|
- Extension file locations
|
|
|
|
**[EXTENSION_ORIGINAL.md](EXTENSION_ORIGINAL.md)**
|
|
Original extension README (kept for reference)
|
|
|
|
### Technical Details
|
|
|
|
**[PORT_DETECTION_README.md](PORT_DETECTION_README.md)**
|
|
How automatic port detection works:
|
|
- Auto-detection mechanism
|
|
- Manual port configuration
|
|
- Priority order
|
|
- Testing and troubleshooting
|
|
|
|
## Quick Links
|
|
|
|
### Task Window
|
|
```bash
|
|
# Run with auto port detection
|
|
python3 task_window.py
|
|
|
|
# Specify port manually
|
|
python3 task_window.py 10001
|
|
```
|
|
|
|
### GNOME Extension
|
|
```bash
|
|
# Check if enabled
|
|
gnome-extensions list --enabled | grep deskmeter
|
|
|
|
# View logs
|
|
journalctl --user -u org.gnome.Shell@wayland.service -f | grep deskmeter
|
|
```
|
|
|
|
### API Testing
|
|
```bash
|
|
# Test dmweb API
|
|
curl http://localhost:10001/api/current_task
|
|
curl http://localhost:10000/api/current_task
|
|
```
|
|
|
|
## Documentation Index
|
|
|
|
| File | Purpose | Audience |
|
|
|------|---------|----------|
|
|
| READY_TO_TEST.md | Complete testing guide | Everyone - start here |
|
|
| TASK_WINDOW_README.md | Task window documentation | Window users |
|
|
| INSTALL_STATUS.md | Extension troubleshooting | Extension users |
|
|
| PORT_DETECTION_README.md | Port detection details | Advanced users |
|
|
| EXTENSION_ORIGINAL.md | Original extension docs | Reference |
|
|
|
|
## Need Help?
|
|
|
|
1. **Start with** [READY_TO_TEST.md](READY_TO_TEST.md) for immediate testing
|
|
2. **For task window issues** see [TASK_WINDOW_README.md](TASK_WINDOW_README.md)
|
|
3. **For extension issues** see [INSTALL_STATUS.md](INSTALL_STATUS.md)
|
|
4. **For port problems** see [PORT_DETECTION_README.md](PORT_DETECTION_README.md)
|