Skip to content

Commit

Permalink
Added more detailed info to the README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
rsubtil authored and Kangie committed Aug 5, 2020
1 parent c95e83d commit 94faabf
Showing 1 changed file with 92 additions and 29 deletions.
121 changes: 92 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@

<p align="center">
<a href="http://www.kernel.org"><img alt="Platform (GNU/Linux)" src="https://img.shields.io/badge/platform-GNU/Linux-blue.svg"></a>
<a href="https://github.com/sindresorhus/awesome"><img alt="Awesome" src="https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg"></a>
<a href="https://travis-ci.org/Komorebi-Fork/komorebi"><img alt="Build Status" src="https://travis-ci.org/Komorebi-Fork/komorebi.svg?branch=master"></a>
</p>

Expand All @@ -21,72 +20,136 @@ alt="Komorebi Demo" width="240" height="180" border="10" /><br>Watch demo</a>
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!

![s1](https://raw.githubusercontent.com/Komorebi-Fork/komorebi/master/screenshots/collage.jpg)
This is a fork of the original [Komorebi project](https://github.com/cheesecakeufo/komorebi) by [@cheesecakeufo](https://github.com/cheesecakeufo).

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

## How do I install Komorebi?
## Installing

### Packaged install (easy)
Komorebi has been tested on:

1. Download `Komorebi` from the [Komorebi releases page](https://github.com/Komorebi-Fork/komorebi/releases).
2. Install Komorebi using your favorite package manager (aka. double click on it)
3. Launch Komorebi!
- **Ubuntu** _18.04_
- **Elementary OS** _5.1.4_
- **Pop! OS** _20.04_
- **Fedora** _32_
- **Manjaro** _20.0.3_
- **Deepin** _20_
- **Arch Linux**
- **Gentoo**

### Manual Installing (advanced)
### Debian and derivatives (Ubuntu, Deepin, Elementary OS, Pop! OS, etc...)

Run the following:
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
```
sudo add-apt-repository ppa:gnome3-team/gnome3 -y
sudo add-apt-repository ppa:vala-team -y
sudo add-apt-repository ppa:gnome3-team/gnome3-staging -y

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

If you wish to compile it instead, then grab the required 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 uses Wayland by default, which Komorebi doesn't support yet. You will have to switch to Xorg for the meantime.**

```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!

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

Install from the [AUR](https://aur.archlinux.org/packages/komorebi/):

```bash
sudo yay -S komorebi
```

or grab the required dependencies:

```bash
sudo pacman -S meson vala gtk3 clutter clutter-gtk clutter-gst libgee
```

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 install
meson build && cd build && meson compile
```

To install the compiled package:
```bash
meson install
```

## Change Wallpaper & Desktop Preferences
## Using Komorebi

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

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.

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

## How do I create my own wallpaper?
### Create custom wallpapers

Komorebi provides a simple tool to create your own wallpapers! Simply, 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 apps and search for **Wallpaper Creator**.

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

You can use either an image, a video, or a web page as a wallpaper and you have many different options to customize your very own wallpaper!

## Uninstall

### If you installed a packaged version of Komorebi
## Uninstalling

1. Open Terminal
2. `sudo apt remove komorebi`
If you manually installed Komorebi, run the following on the cloned repository folder:

### If you manually installed Komorebi
```bash
cd build
sudo ninja uninstall
```

1. Open Terminal
2. `cd komorebi/build`
3. `sudo ninja uninstall`
If you didn't compile Komorebi from source, you can uninstall it through your package manager in the same way you would uninstall any other package.

## Questions? Issues?

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

Komorebi includes support for video wallpapers that might slow your computer down. You can disable support for video wallpapers in 'Desktop Preferences' → uncheck 'Enable Video Wallpapers'.
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).

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 :(

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

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

The latest Komorebi should already have a fix for this issue. If you've already uninstalled Komorebi and would like to fix the issue, simply run this (in the Terminal):
The latest version should already have a fix for this issue. If you've already uninstalled Komorebi and would like to fix the issue, simply run this (in the Terminal):
`curl -s https://github.com/raw/Komorebi-Fork/komorebi/master/data/Other/postrm | bash -s`

If your issue has not already been reported, please report it *[`here`](https://github.com/Komorebi-Fork/komorebi/issues/new)*.
If your issue has not already been reported, please report it [here](https://github.com/Komorebi-Fork/komorebi/issues/new).

### Thanks To:

Pete Lewis ([@PJayB](https://github.com/PJayB)) for adding mult-monitor support
Pete Lewis ([@PJayB](https://github.com/PJayB)) for adding multi-monitor support

0 comments on commit 94faabf

Please sign in to comment.