diff --git a/README.md b/README.md index f69362a..1b57a8c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,65 @@ -# Wallify +**Wallify (Live Wallpaper Engine)** +===================================== -Wallify is a live wallpaper engine that allows you to set animated wallpapers on your Linux desktop. It uses the wallify command to render the wallpaper and mpv to play the animation. \ No newline at end of file +**Table of Contents** +----------------- + +1. [Introduction](#introduction) +2. [Features](#features) +3. [Setup](#setup) +4. [Usage](#usage) +5. [Troubleshooting](#troubleshooting) +6. [Author](#author) + +**Introduction** +--------------- + +Wallify is a live wallpaper engine that allows you to set animated wallpapers on your Linux desktop. It uses the `wallify` command to render the wallpaper and `mpv` to play the animation. + +**Features** +------------ + +* Set animated wallpapers on your Linux desktop +* Supports various file formats (e.g., GIF, MP4, WebM) +* Customizable settings for animation playback +* Autostart feature to launch the wallpaper on startup + +**Setup** +-------- + +To set up Wallify, run the `setup.sh` script in the terminal: +```bash +./setup.sh +``` +Follow the prompts to select a wallpaper file and configure the settings. + +**Usage** +----- + +Once set up, the wallpaper will lauch it self at the next startup. +Wallify is configured in autostart on login by adding the `start.sh` script to your system's autostart directory. + +**Troubleshooting** +------------------ + +* If you encounter issues with the wallpaper not displaying, check the `wallpaper.conf` file to ensure the correct file path is specified. +* If you experience performance issues, create a ticket ! + +**Author** +--------- + +This project was created by @mathis.chirat + +**License** +------- + +Wallify is licensed under the GNU General Public License (GPL) version 3. + +**Acknowledgments** +------------------ + +Wallify uses the following open-source projects: + +* `wallify`: a live wallpaper engine +* `mpv`: a media player +* `zenity`: a graphical user interface toolkit