|
1 | | -## munliwall |
| 1 | +# munliwall |
2 | 2 |
|
3 | | -### Description |
| 3 | +A simple yet powerful tool designed to transform your workspace with ease. `munliwall` lets you effortlessly manage your desktop backgrounds — download stunning wallpapers, upload your own creations, or update your setup automatically. |
4 | 4 |
|
5 | | -A simple yet powerful tool designed to transform your workspace with ease. **munliwall** lets you effortlessly manage your desktop backgrounds — whether you want to **download stunning wallpapers from the web**, **upload your own creations**, or **update your current setup automatically**. |
| 5 | +## Installation |
6 | 6 |
|
7 | | -The tool can be used both as a **command-line interface (CLI)** and a **desktop app**, giving you flexibility and control. You can fetch new wallpapers by keyword, source, or category, schedule automatic updates, or quickly apply local images — all without the hassle of manual setup. |
| 7 | +### Desktop Application (Linux) |
8 | 8 |
|
9 | | -### Sources Supported |
10 | | -- **nekos** |
11 | | -- **local** |
12 | | -- **unsplash** |
| 9 | +You can download the latest version of the desktop application from the [Releases](https://github.com/munlicode/munliwall/releases) page. We provide support for AppImage, Debian (.deb), and Snap packages. |
13 | 10 |
|
| 11 | +#### AppImage (Recommended) |
| 12 | + |
| 13 | +1. Download `munliwall-x.x.x.AppImage`. |
| 14 | +2. Make it executable: |
| 15 | + ```bash |
| 16 | + chmod +x munliwall-x.x.x.AppImage |
| 17 | + ``` |
| 18 | +3. Run it: |
| 19 | + ```bash |
| 20 | + ./munliwall-x.x.x.AppImage |
| 21 | + ``` |
| 22 | + |
| 23 | +#### Debian Package (.deb) |
| 24 | + |
| 25 | +1. Download `munliwall-x.x.x.deb`. |
| 26 | +2. Install it using `dpkg`: |
| 27 | + ```bash |
| 28 | + sudo dpkg -i munliwall-x.x.x.deb |
| 29 | + ``` |
| 30 | + (Run `sudo apt install -f` if you encounter dependency errors) |
| 31 | +3. Launch "munliwall" from your applications menu. |
| 32 | + |
| 33 | +#### Snap Package |
| 34 | + |
| 35 | +1. Download `munliwall-x.x.x.snap`. |
| 36 | +2. Install it: |
| 37 | + ```bash |
| 38 | + sudo snap install munliwall-x.x.x.snap --dangerous |
| 39 | + ``` |
| 40 | + *(Note: The `--dangerous` flag is required because the package is installed locally and not verified by the Snap Store signature).* |
| 41 | + |
| 42 | +### CLI Tool |
| 43 | + |
| 44 | +The CLI tool allows you to manage wallpapers directly from your terminal. |
| 45 | + |
| 46 | +1. Download `cli.zip` from the Releases page. |
| 47 | +2. Unzip the archive: |
| 48 | + ```bash |
| 49 | + unzip cli.zip |
| 50 | + ``` |
| 51 | +3. Navigate to the `dist` directory. |
| 52 | +4. Run the CLI: |
| 53 | + ```bash |
| 54 | + ./munliwall --help |
| 55 | + ``` |
| 56 | + |
| 57 | +**Example Commands:** |
| 58 | + |
| 59 | +* **Set a random wallpaper:** |
| 60 | + ```bash |
| 61 | + ./munliwall random |
| 62 | + ``` |
| 63 | +* **Set a wallpaper from a specific source (e.g., Unsplash):** |
| 64 | + ```bash |
| 65 | + ./munliwall set --source unsplash --query "nature" |
| 66 | + ``` |
| 67 | +* **List history:** |
| 68 | + ```bash |
| 69 | + ./munliwall history |
| 70 | + ``` |
| 71 | + |
| 72 | +## Development |
| 73 | + |
| 74 | +To build the project locally: |
| 75 | + |
| 76 | +1. Clone the repository. |
| 77 | +2. Install dependencies: |
| 78 | + ```bash |
| 79 | + pnpm install |
| 80 | + ``` |
| 81 | +3. Build the desktop app: |
| 82 | + ```bash |
| 83 | + pnpm --filter @munlicode/munliwall-desktop run build |
| 84 | + ``` |
| 85 | + |
| 86 | +## License |
| 87 | + |
| 88 | +MIT |
0 commit comments