mirror of
https://github.com/Bismuth-Forge/bismuth.git
synced 2024-09-11 08:25:39 +03:00
refactor: run prettier on markdown
This commit is contained in:
parent
f0c205c61f
commit
a9115b337a
15
.github/ISSUE_TEMPLATE/bug_report.md
vendored
15
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -1,16 +1,16 @@
|
||||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
title: ""
|
||||
labels: bug
|
||||
assignees: ''
|
||||
|
||||
assignees: ""
|
||||
---
|
||||
|
||||
**Symptom**
|
||||
A simple description of the problem you're experiencing.
|
||||
|
||||
**How to Reproduce**
|
||||
|
||||
1. Launch '....'
|
||||
2. Press key '....'
|
||||
3. See error
|
||||
@ -19,10 +19,11 @@ A simple description of the problem you're experiencing.
|
||||
A concise description of what you expected to happen.
|
||||
|
||||
**Environment**
|
||||
- Distro: [e.g. Ubuntu 18.04, Debian 9.5, Archlinux]
|
||||
- KWin version: [e.g. 5.14.2]
|
||||
- Krohnkite version: [e.g. 0.1, git commit]
|
||||
- List of KWin scripts in use: [e.g. MinimizeAll, VideoWall]
|
||||
|
||||
- Distro: [e.g. Ubuntu 18.04, Debian 9.5, Archlinux]
|
||||
- KWin version: [e.g. 5.14.2]
|
||||
- Krohnkite version: [e.g. 0.1, git commit]
|
||||
- List of KWin scripts in use: [e.g. MinimizeAll, VideoWall]
|
||||
|
||||
**Notes**
|
||||
Anything that you want to tell developers about.
|
||||
|
@ -1,4 +1,3 @@
|
||||
build
|
||||
node_modules
|
||||
*.md
|
||||
|
||||
|
170
README.md
170
README.md
@ -1,47 +1,42 @@
|
||||
Bismuth
|
||||
=========
|
||||
# Bismuth
|
||||
|
||||
A dynamic tiling extension for KWin.
|
||||
|
||||
![screenshot](img/screenshot.png)
|
||||
|
||||
## Features
|
||||
|
||||
Features
|
||||
--------
|
||||
* DWM-like window tiling
|
||||
- Dynamically tile windows, rather than manually placing each.
|
||||
- Floating windows
|
||||
* Fully integrates into KWin features, including:
|
||||
- **Multi-screen**
|
||||
- **Activities & Virtual desktop**
|
||||
- Basic window management (minimize, fullscreen, switching, etc)
|
||||
* Multiple Layout Support
|
||||
- Tiling layout
|
||||
- Monocle layout
|
||||
- Desktop-friendly layouts (Spread, Stair)
|
||||
- DWM-like window tiling
|
||||
- Dynamically tile windows, rather than manually placing each.
|
||||
- Floating windows
|
||||
- Fully integrates into KWin features, including:
|
||||
- **Multi-screen**
|
||||
- **Activities & Virtual desktop**
|
||||
- Basic window management (minimize, fullscreen, switching, etc)
|
||||
- Multiple Layout Support
|
||||
- Tiling layout
|
||||
- Monocle layout
|
||||
- Desktop-friendly layouts (Spread, Stair)
|
||||
|
||||
Development Requirement
|
||||
-----------------------
|
||||
## Development Requirement
|
||||
|
||||
* Typescript (tested w/ 3.1.x)
|
||||
* GNU Make
|
||||
* p7zip (7z)
|
||||
- Typescript (tested w/ 3.1.x)
|
||||
- GNU Make
|
||||
- p7zip (7z)
|
||||
|
||||
|
||||
Installation
|
||||
------------
|
||||
## Installation
|
||||
|
||||
You can install Bismuth in multiple ways.
|
||||
|
||||
### Using .kwinscript package file ###
|
||||
### Using .kwinscript package file
|
||||
|
||||
You can download `bismuth-x.x.kwinscript` file, and install it through
|
||||
*System Settings*.
|
||||
_System Settings_.
|
||||
|
||||
1. Download the kwinscript file
|
||||
2. Open `System Settings` > `Window Management` > `KWin Scripts`
|
||||
3. Press `Import KWin script...` on the top-right corner
|
||||
4. Select the downloaded file
|
||||
1. Download the kwinscript file
|
||||
2. Open `System Settings` > `Window Management` > `KWin Scripts`
|
||||
3. Press `Import KWin script...` on the top-right corner
|
||||
4. Select the downloaded file
|
||||
|
||||
Alternatively, through command-line:
|
||||
|
||||
@ -52,7 +47,7 @@ To uninstall the package:
|
||||
|
||||
plasmapkg2 -t kwinscript -r bismuth
|
||||
|
||||
### Installing from Git repository ###
|
||||
### Installing from Git repository
|
||||
|
||||
The simplest method would be:
|
||||
|
||||
@ -67,7 +62,7 @@ You can also manually build package file using:
|
||||
|
||||
The generated package file can be imported from "KWin Script" dialog.
|
||||
|
||||
### Simply Trying Out ###
|
||||
### Simply Trying Out
|
||||
|
||||
Bismuth can be temporarily loaded without installing the script:
|
||||
|
||||
@ -77,7 +72,7 @@ Bismuth can be temporarily loaded without installing the script:
|
||||
Note that Bismuth can destroy itself completely once it is disabled, so no
|
||||
restart is required to deactivated it.
|
||||
|
||||
### Enabling User-Configuration ###
|
||||
### Enabling User-Configuration
|
||||
|
||||
[It is reported][kwinconf] that a manual step is required to enable user
|
||||
configuration of KWin scripts. This is a limitation of KWin scripting.
|
||||
@ -92,51 +87,48 @@ A configuration button will appear in `KWin Scripts` in `System Settings`.
|
||||
![config button shown](img/conf.png)
|
||||
|
||||
To make changes effective, **the script must be reactivated**:
|
||||
1) On `KWin Scripts` dialog, untick Bismuth
|
||||
2) `Apply`
|
||||
3) tick Bismuth
|
||||
4) `Apply`
|
||||
|
||||
1. On `KWin Scripts` dialog, untick Bismuth
|
||||
2. `Apply`
|
||||
3. tick Bismuth
|
||||
4. `Apply`
|
||||
|
||||
[kwinconf]: https://github.com/faho/kwin-tiling/issues/79#issuecomment-311465357
|
||||
|
||||
## Default Key Bindings
|
||||
|
||||
Default Key Bindings
|
||||
--------------------
|
||||
| Key | Action |
|
||||
| ---------------- | ------------------ |
|
||||
| Meta + J | Focus Down/Next |
|
||||
| Meta + K | Focus Up/Previous |
|
||||
| Meta + H | Left |
|
||||
| Meta + L | Right |
|
||||
| | |
|
||||
| Meta + Shift + J | Move Down/Next |
|
||||
| Meta + Shift + K | Move Up/Previous |
|
||||
| Meta + Shift + H | Move Left |
|
||||
| Meta + Shift + L | Move Right |
|
||||
| | |
|
||||
| Meta + I | Increase |
|
||||
| Meta + D | Decrease |
|
||||
| Meta + F | Toggle Floating |
|
||||
| Meta + \ | Cycle Layout |
|
||||
| | |
|
||||
| Meta + Return | Set as Master |
|
||||
| | |
|
||||
| Meta + T | Use Tile Layout |
|
||||
| Meta + M | Use Monocle Layout |
|
||||
| _unbound_ | Use Spread Layout |
|
||||
| _unbound_ | Use Stair Layout |
|
||||
|
||||
| Key | Action |
|
||||
| ----------------- | ------------------------------ |
|
||||
| Meta + J | Focus Down/Next |
|
||||
| Meta + K | Focus Up/Previous |
|
||||
| Meta + H | Left |
|
||||
| Meta + L | Right |
|
||||
| | |
|
||||
| Meta + Shift + J | Move Down/Next |
|
||||
| Meta + Shift + K | Move Up/Previous |
|
||||
| Meta + Shift + H | Move Left |
|
||||
| Meta + Shift + L | Move Right |
|
||||
| | |
|
||||
| Meta + I | Increase |
|
||||
| Meta + D | Decrease |
|
||||
| Meta + F | Toggle Floating |
|
||||
| Meta + \ | Cycle Layout |
|
||||
| | |
|
||||
| Meta + Return | Set as Master |
|
||||
| | |
|
||||
| Meta + T | Use Tile Layout |
|
||||
| Meta + M | Use Monocle Layout |
|
||||
| *unbound* | Use Spread Layout |
|
||||
| *unbound* | Use Stair Layout |
|
||||
## Tips
|
||||
|
||||
|
||||
Tips
|
||||
----
|
||||
|
||||
### Setting Up for Multi-Screen ###
|
||||
### Setting Up for Multi-Screen
|
||||
|
||||
Bismuth supports multi-screen setup, but KWin has to be configured to unlock
|
||||
the full potential of the script.
|
||||
|
||||
1. Enable `Separate Screen Focus` under `Window Management` >
|
||||
1. Enable `Separate Screen Focus` under `Window Management` >
|
||||
`Window Behavior` > `Multiscreen Behaviour`
|
||||
2. Bind keys for global shortcut `Switch to Next/Previous Screen`
|
||||
(Recommend: `Meta + ,` / `Meta + .`)
|
||||
@ -145,7 +137,7 @@ the full potential of the script.
|
||||
|
||||
Note: `Separate Screen Focus` appears only when multiple monitors are present.
|
||||
|
||||
### Removing Title Bars ###
|
||||
### Removing Title Bars
|
||||
|
||||
Breeze window decoration can be configured to completely remove title bars from
|
||||
all windows:
|
||||
@ -157,29 +149,31 @@ all windows:
|
||||
- `Regular expression to match`: `.*`
|
||||
- Tick `Hide window title bar`
|
||||
|
||||
### Changing Border Colors ###
|
||||
### Changing Border Colors
|
||||
|
||||
Changing the border color makes it easier to identify current window. This is
|
||||
convinient if title bars are removed.
|
||||
|
||||
1. Open `~/.config/kdeglobals` with your favorite editor
|
||||
2. Scroll down and find `[WM]` section
|
||||
3. Append the followings to the section:
|
||||
- `frame=61,174,233`: set the border color of active window to *RGB(61,174,233)*
|
||||
- `inactiveFrame=239,240,241`: set the border color of inactive window to *RGB(239,240,241)*
|
||||
1. Open `~/.config/kdeglobals` with your favorite editor
|
||||
2. Scroll down and find `[WM]` section
|
||||
3. Append the followings to the section:
|
||||
|
||||
Here's a nice 2-liner that'll do it for you:
|
||||
- `frame=61,174,233`: set the border color of active window to _RGB(61,174,233)_
|
||||
- `inactiveFrame=239,240,241`: set the border color of inactive window to _RGB(239,240,241)_
|
||||
|
||||
kwriteconfig5 --file ~/.config/kdeglobals --group WM --key frame 61,174,233
|
||||
kwriteconfig5 --file ~/.config/kdeglobals --group WM --key inactiveFrame 239,240,241
|
||||
4. You must **restart** your session to see changes. (i.e. re-login, reboot)
|
||||
Here's a nice 2-liner that'll do it for you:
|
||||
|
||||
kwriteconfig5 --file ~/.config/kdeglobals --group WM --key frame 61,174,233
|
||||
kwriteconfig5 --file ~/.config/kdeglobals --group WM --key inactiveFrame 239,240,241
|
||||
|
||||
4. You must **restart** your session to see changes. (i.e. re-login, reboot)
|
||||
|
||||
Note: the RGB values presented here are for the default Breeze theme
|
||||
|
||||
Note: You might also need to set the border size larger than the theme's default:
|
||||
`System Settings` > `Application Style` > `Window Decorations`: Untick `Use theme's default window border size` and adjust the size (right from the checkbox).
|
||||
|
||||
### Setting Minimum Geometry Size ###
|
||||
### Setting Minimum Geometry Size
|
||||
|
||||
Some applications like discord and KDE settings dont tile nicely as they have a minimum size requirement.
|
||||
This causes the applications to overlap with other applications. To mitigate this we can set minimum size for all windows to be 0.
|
||||
@ -193,14 +187,12 @@ This causes the applications to overlap with other applications. To mitigate thi
|
||||
7. Set the fields to `Force` and `0` x `0`
|
||||
8. Apply
|
||||
|
||||
Useful Development Resources
|
||||
----------------------------
|
||||
|
||||
* [KWin Scripting Tutorial](https://techbase.kde.org/Development/Tutorials/KWin/Scripting)
|
||||
* [KWin Scripting API 4.9 Reference](https://techbase.kde.org/Development/Tutorials/KWin/Scripting/API_4.9)
|
||||
* Adding configuration dialog
|
||||
- [Development/Tutorials/Plasma/JavaScript/ConfigDialog](https://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/ConfigDialog)
|
||||
- [Development/Tutorials/Using KConfig XT](https://techbase.kde.org/Development/Tutorials/Using_KConfig_XT)
|
||||
* `*.ui` files can be edited with [Qt Designer](http://doc.qt.io/qt-5/qtdesigner-manual.html).
|
||||
It's very straight-forward if you're used to UI programming.
|
||||
## Useful Development Resources
|
||||
|
||||
- [KWin Scripting Tutorial](https://techbase.kde.org/Development/Tutorials/KWin/Scripting)
|
||||
- [KWin Scripting API 4.9 Reference](https://techbase.kde.org/Development/Tutorials/KWin/Scripting/API_4.9)
|
||||
- Adding configuration dialog
|
||||
- [Development/Tutorials/Plasma/JavaScript/ConfigDialog](https://techbase.kde.org/Development/Tutorials/Plasma/JavaScript/ConfigDialog)
|
||||
- [Development/Tutorials/Using KConfig XT](https://techbase.kde.org/Development/Tutorials/Using_KConfig_XT)
|
||||
- `*.ui` files can be edited with [Qt Designer](http://doc.qt.io/qt-5/qtdesigner-manual.html).
|
||||
It's very straight-forward if you're used to UI programming.
|
||||
|
Loading…
Reference in New Issue
Block a user