Skip to content

Commit

Permalink
Readme Update
Browse files Browse the repository at this point in the history
  • Loading branch information
Kangie committed Sep 9, 2020
1 parent 0fe5a0a commit 4d0f385
Showing 1 changed file with 28 additions and 13 deletions.
41 changes: 28 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,18 +17,18 @@ alt="Komorebi Demo" width="240" height="180" border="10" /><br>Watch demo</a>

## What is Komorebi?

Komorebi is an awesome animated wallpaper manager for all Linux platforms.
It provides fully customizeable image, video, and web page wallpapers that can be tweaked at any time!
Komorebi is an animated wallpaper manager for all Linux platforms.
It provides you with fully customisable image, video, and web page wallpapers that you can tweak at any time!

This is a fork of the original [Komorebi project](https://github.com/cheesecakeufo/komorebi) by [@cheesecakeufo](https://github.com/cheesecakeufo).
This project is a fork of the original [Komorebi](https://github.com/cheesecakeufo/komorebi) by [@cheesecakeufo](https://github.com/cheesecakeufo).

![s1](https://raw.githubusercontent.com/Komorebi-Fork/komorebi/master/screenshots/collage.jpg)

## Installing

Komorebi has been tested on:

- **Ubuntu** _18.04_
- **Ubuntu** _18.04_, _20.04_
- **Elementary OS** _5.1.4_
- **Pop! OS** _20.04_
- **Fedora** _32_
Expand All @@ -40,29 +40,39 @@ Komorebi has been tested on:
### Debian and derivatives (Ubuntu, Deepin, Elementary OS, Pop! OS, etc...)

Download the latest `.deb` package from our [releases page](https://github.com/Komorebi-Fork/komorebi/releases/) and install it with:

```bash

sudo dpkg -i komorebi_2.2.0-1.deb
```

*(or by double-clicking on the downloaded file.)*

If you wish to compile it instead, then grab the required dependencies:
If you'd like to compile Komorebi from source instead, you'll need to install the following dependencies:

```bash
sudo apt install meson valac libgtk-3-dev libgee-0.8-dev libclutter-gtk-1.0-dev libclutter-1.0-dev libwebkit2gtk-4.0-dev libclutter-gst-3.0-dev
```

and jump to the [compiling section](#compiling).

### Fedora
### Fedora / OpenSUSE

**Fedora uses Wayland by default, which Komorebi doesn't support yet. You will have to switch to Xorg for the meantime.**

Grab the appropriate rpm from [here](https://build.opensuse.org/package/show/home%3ANNowakowski/Komorebi-Fork), and install it.

```bash
sudo rpm -ivh komorebi-2.2.0-9.1.x86_64.rpm
```

If you'd like to compile Komorebi from source instead, you'll need to install the following dependencies:

```bash
sudo dnf install meson vala gcc-c++ gtk3-devel clutter-devel clutter-gtk-devel clutter-gst3-devel webkit2gtk3-devel libgee-devel gstreamer1-libav
```

There is no `.rpm` package yet, jump to the [compiling section](#compiling); if you can package Komorebi for Fedora, go ahead and let us know!
and jump to the [compiling section](#compiling).

### Arch Linux and derivatives (Manjaro, etc...)

Expand All @@ -83,34 +93,39 @@ and jump to the [compiling section](#compiling).
## Compiling

Run the following:

```bash
git clone https://github.com/Komorebi-Fork/komorebi.git
cd komorebi
meson build && cd build && meson compile
```

To install the compiled package:

```bash
meson install
```

## Using Komorebi

Simply run `komorebi`, or open your apps and look for **Komorebi**.
Simply run `komorebi`, or open your application launcher and look for **Komorebi**.

Komorebi displays behind all other windows, so you may not notice anything if you have a fullscreen application running.

Optional arguments:

- `--single-screen`: forces Komorebi to run on the main screen only
- `version` or `--version`: prints current version

### Change wallpaper & desktop preferences
To change desktop preferences or your wallpaper, right click anywhere on the desktop to show the menu.

Komorebi's preferences (including the wallpaper selector) can be accessed from the bubble menu, available by right-clicking on the desktop.

![s1](https://raw.githubusercontent.com/Komorebi-Fork/komorebi/master/screenshots/preferences.jpg)

### Create custom wallpapers

Komorebi provides a simple tool to create your own wallpapers! Simply run `komorebi-wallpaper-creator` or open your apps and search for **Wallpaper Creator**.
Komorebi provides a simple tool to create your own wallpapers! Simply run `komorebi-wallpaper-creator` or open your application launcher and search for **Wallpaper Creator**.

![s1](https://raw.githubusercontent.com/Komorebi-Fork/komorebi/master/screenshots/wallpaper_creator.jpg)

Expand All @@ -131,17 +146,17 @@ If you didn't compile Komorebi from source, you can uninstall it through your pa

### Komorebi is slow. What can I do about it?

Komorebi includes support for video wallpapers that might slow your computer down. There are a few tips you can do to increase performance, [detailed here](https://github.com/Komorebi-Fork/komorebi/wiki/Improve-video-wallpapers-performance).
Komorebi includes support for video wallpapers that might slow your computer down. We've put together a few tips that you can use to increase performance on the [wiki](https://github.com/Komorebi-Fork/komorebi/wiki/Improve-video-wallpapers-performance).

You can also disable support for video wallpapers altogether in 'Desktop Preferences' → uncheck 'Enable Video Wallpapers'.

_note: you need to quit and re-open Komorebi after changing this option_

### Komorebi is crashing and I'm using two or more screens!

This is a [known bug](https://github.com/Komorebi-Fork/komorebi/issues/18) that currently has no good solution in the meantime :(
This is a [known bug](https://github.com/Komorebi-Fork/komorebi/issues/18). There's currently no solution for this, but if you have any ideas we'd love to hear from you!

For now, you can force Komorebi to launch on the main screen only by running it with `--single-screen`.
For now, you can force Komorebi to display on the main screen only by running it with `--single-screen`.

### After uninstalling, my desktop isn't working right (blank or no icons)

Expand Down

0 comments on commit 4d0f385

Please sign in to comment.