Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
abcdqfr authored Dec 4, 2024
1 parent bfae154 commit a22de67
Showing 1 changed file with 16 additions and 19 deletions.
35 changes: 16 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ This project aims to provide a native GTK interface for linux-wallpaperengine, m
- 🎵 Audio controls (volume/mute)
- 🖥️ Multi-monitor support
- ⚙️ Graphical settings management
- 🔧 System tray integration with quick controls
FUTURE- 🔧 System tray integration with quick controls

## Prerequisites

Expand Down Expand Up @@ -47,38 +47,37 @@ This project aims to provide a native GTK interface for linux-wallpaperengine, m
cmake ..
make



2. Install Linux Wallpaper Engine GTK:

### From PyPI (Recommended)

pip install linux-wallpaperengine-gtk

### From Source

git clone /~https://github.com/abcdqfr/linux-wallpaperengine-gtk.git
cd linux-wallpaperengine-gtk
pip install -e .
python3 linux-wallpaperengine-gtk.py

## Configuration

On first run, the application will create a configuration file at:

~/.config/linux-wallpaperengine-gtk/config.json

~/.config/linux-wallpaperengine-gtk/config.json

Default paths:
- Linux Wallpaper Engine: `~/linux-wallpaperengine/build`
- Wallpapers: `~/.steam/debian-installation/steamapps/workshop/content/431960`
- Others*
- `~/linux-wallpaperengine/build`
- `~/.steam/steam/steamapps/workshop/content/431960`
- `~/.steam/debian-installation/steamapps/workshop/content/431960`
- `~/.local/share/Steam/steamapps/workshop/content/431960`

You can change these paths in the settings dialog.

## Usage

### Starting the Application

Launch the py file from anywhere, it will auto detect all resources if they can be found in common default locations. ###
Launch the application by running:

python3 linux-wallpaperengine-gtk.py

The application will automatically detect linux-wallpaperengine and wallpapers in common locations.

### Basic Controls

Expand Down Expand Up @@ -124,11 +123,9 @@ The application minimizes to system tray. Right-click the tray icon for quick ac

### Debug Mode

Run with debug logging:

LINUX_WPE_DEBUG=1 linux-wallpaperengine-gtk

Run with debug logging enabled:

python3 linux-wallpaperengine-gtk.py --debug

## Contributing

Expand All @@ -140,7 +137,7 @@ Run with debug logging:

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
This project is licensed under the MIT License.

## Acknowledgments

Expand Down

0 comments on commit a22de67

Please sign in to comment.