Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
kupiqu committed Dec 3, 2019
1 parent e16052f commit 6081797
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 17 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

project(sierrabreezeenhanced)
set(PROJECT_VERSION "0.7.6")
set(PROJECT_VERSION "0.7.7")
set(PROJECT_VERSION_MAJOR 0)

cmake_minimum_required(VERSION 2.8.12 FATAL_ERROR)
Expand Down
10 changes: 10 additions & 0 deletions ChangeLog
Original file line number Diff line number Diff line change
@@ -1,3 +1,13 @@
V0.7.7
---------

* README update
* SierraBreezeEnhanced renamed to Sierra Breeze Enhanced
* Gradients apply to inactive windows but slightlier than to active windows
* Resize of some Dark Aurorae symbols
* mac renamed to macOS
* Some cleaning

V0.7.6
---------

Expand Down
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,19 @@
# SierraBreezeEnhanced
# Sierra Breeze Enhanced

## Overview

SierraBreezeEnhanced is a fork of BreezeEnhanced decoration with the following changes:
Sierra Breeze Enhanced started as a fork of Breeze Enhanced decoration. It has the following main features:

* non-gray colors do not change.
* active window: show symbol on hovering.
* inactive window: always show symbol, show ring color on hovering.
* application menu button is considered special and stays as in vanilla breeze.
* no more option for non macOS-like buttons as it doesn't apply anymore.
* added, however, an option to either choose active vs. inactive style (default), always active style (also for non-active windows), or inactive style (also for the active window).
* horizontal padding to better adjust the button position in case of use of rounded corners.
* Button style options: Plasma / Gnome / macOS Sierra / macOS Dark Aurorae / SBE Sierra themes / SBE Dark Aurorae themes / Color Symbols themes / Monochrome Symbols themes (Note: the application menu button is considered special and does not change).
* Button spacing and padding Options.
* Button hovering animation.
* Option to make all button symbols to appear at unison on hovering (Note: it does not apply to symbol themes).
* Titlebar style options: SBE own style of Line Separation between Titlebar and Window / Match Titlebar color to Window color / Hide Titlebar under certain circumstances (Never/Maximization/Any Maximization (including H/V)/Always) / Gradient Adjustments / Opacity Adjustments / Font Adjustments.
* Specific Shadow settings for inactive windows

## Credits:

SierraBreezeEnhanced is strongly based on BreezeEnhanced and SierraBreeze.
Breeze, Sierra Breeze and Breeze Enhanced for obvious reasons.

## Build dependencies

Expand Down Expand Up @@ -46,7 +45,7 @@ cmake .. -DCMAKE_INSTALL_PREFIX=/usr -DCMAKE_BUILD_TYPE=Release -DKDE_INSTALL_LI
make
sudo make install
```
After the intallation, restart KWin by logging out and in. Then, SierraBreezeEnhanced will appear in *System Settings → Application Style → Window Decorations*.
After the intallation, restart KWin by logging out and in. Then, Sierra Breeze Enhanced will appear in *System Settings → Application Style → Window Decorations*.

Alternatively install from script (which does the above):
```sh
Expand Down Expand Up @@ -86,7 +85,7 @@ cd build
sudo make uninstall
```

## Screenshots:
## Screenshot of SBE Sierra theme (or How it All started...):

![Active Buttons](screenshots/ActiveButtons.gif?raw=true "Active Buttons")
![Inactive Buttons](screenshots/InactiveButtons.gif?raw=true "Inactive Buttons")
4 changes: 2 additions & 2 deletions breeze.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
"Description": "Window decoration based on SierraBreeze and BreezeEnhanced styles for the Plasma Desktop",
"EnabledByDefault": true,
"Id": "org.kde.sierrabreezeenhanced",
"Name": "SierraBreezeEnhanced",
"Name": "Sierra Breeze Enhanced",
"ServiceTypes": [
"org.kde.kdecoration2"
]
},
"org.kde.kdecoration2": {
"blur": true,
"defaultTheme": "SierraBreezeEnhanced",
"defaultTheme": "Sierra Breeze Enhanced",
"kcmodule": true,
"recommendedBorderSize": "Tiny"
}
Expand Down
4 changes: 2 additions & 2 deletions config/ui/breezeconfigurationui.ui
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@
</item>
<item>
<property name="text">
<string>mac Sierra</string>
<string>macOS Sierra</string>
</property>
</item>
<item>
<property name="text">
<string>mac Dark Aurorae</string>
<string>macOS Dark Aurorae</string>
</property>
</item>
<item>
Expand Down

0 comments on commit 6081797

Please sign in to comment.