Bismuth-Forge/bismuth
1
1
Fork 0
mirror of https://github.com/Bismuth-Forge/bismuth.git synced 2024-09-17 11:37:10 +03:00
Code Issues Packages Projects Releases Wiki Activity
KDE Plasma add-on, that tiles your windows automatically and lets you manage them via keyboard, similarly to i3, Sway or dwm.
804 Commits 15 Branches 18 Tags 12 MiB
TypeScript 65.5%
C++ 10.5%
QML 9.8%
CMake 9.7%
Shell 4.2%
Other 0.3%
b43ca58b33
Go to file
Mikhail Zolotukhin b43ca58b33 chore: move tests and add signal wrapper example 
Tests are better kept in a separate binary. This prevents some of the
linking errors and allows us to define the mock KWin objects with no
fear.
2022-02-15 20:19:12 +03:00
.github chore: replace husky with pre-commit 2022-02-09 22:29:09 +03:00
.reuse chore: replace husky with pre-commit 2022-02-09 22:29:09 +03:00
cmake chore: workspace wrapper template with doctest 2022-02-08 16:40:57 +03:00
contrib chore: replace husky with pre-commit 2022-02-09 22:29:09 +03:00
external/doctest chore: replace husky with pre-commit 2022-02-09 22:29:09 +03:00
img docs: rearrange readmes 2022-01-08 01:01:18 +03:00
LICENSES chore: replace husky with pre-commit 2022-02-09 22:29:09 +03:00
scripts chore: move tests and add signal wrapper example 2022-02-15 20:19:12 +03:00
src chore: move tests and add signal wrapper example 2022-02-15 20:19:12 +03:00
tests chore: move tests and add signal wrapper example 2022-02-15 20:19:12 +03:00
.editorconfig chore: remove file specific rules from the .editorconfig 2021-11-08 20:42:32 +03:00
.eslintrc.json ci: 👷 add prettier eslint plugin 2021-09-30 19:21:10 +03:00
.git-blame-ignore-revs chore: replace husky with pre-commit 2022-02-09 22:29:09 +03:00
.gitignore chore: remove vscode stuff 2022-02-09 22:29:09 +03:00
.pre-commit-config.yaml chore: replace husky with pre-commit 2022-02-09 22:29:09 +03:00
.prettierignore chore: replace husky with pre-commit 2022-02-09 22:29:09 +03:00
CHANGELOG.md chore: release 2.3.0 2022-01-26 20:53:44 +03:00
CMakeLists.txt refactor: move logging to core 2022-02-10 20:00:57 +03:00
CONTRIBUTING.md chore: replace husky with pre-commit 2022-02-09 22:29:09 +03:00
LICENSE chore: 📝 add license symlink for GitHub recognition 2021-09-23 23:00:15 +03:00
package.json chore: replace husky with pre-commit 2022-02-09 22:29:09 +03:00
README.md chore: lower the frameworks and Plasma requirements 2022-02-09 21:10:36 +03:00
ROADMAP.md docs: add roadmap 2021-11-15 01:20:34 +03:00
tsconfig.json chore: fix documentation building 2021-12-01 16:38:58 +03:00

README.md

🌈 Bismuth 🌈

Making tiling window management easy. On KDE Plasma.

wayland: supported GitHub release (latest SemVer) Matrix Donate

demo

Arrange your windows in different grids to minimize the mouse usage.

🌟 Features 🌟

Automatic window tiling

Save your time by automatically managing windows on your screen.

https://user-images.githubusercontent.com/14205339/148453685-f1bcfa46-4952-4b9d-a6f1-d2d75a0b4992.mp4


Plasma integration

Power-up your workflow using native Plasma features - Virtual Desktops and Activities.

https://user-images.githubusercontent.com/14205339/148562411-c9cca82a-c694-4794-b5e4-8fe716ec3d98.mp4


Multiple Layouts

Use different layouts in different contexts.

https://user-images.githubusercontent.com/14205339/148564378-1def9350-a871-4f75-ba66-7a59ea1d4680.mp4




🏁 Getting Started

Requirements

  • A Linux distribution with KDE Plasma version 5.20 or higher
  • Qt version 5.15 or higher
  • KDE Frameworks version 5.78 or higher

You can check if your system matches these requirements by going to System Settings > About this System.

Installation

⚠️ Distributions' packages are not affiliated with Bismuth developers. If you encounter any issues with the incorrect installation, you should contact the package maintainer first.

Arch Linux

Debian

Ubuntu

Fedora

OpenSUSE Tumbleweed

Gentoo

Solus

From Source

If you know a packaging solution for a distribution, that is not in the list, please open a pull request.

Usage

🎉 To start using Bismuth enable it in System Settings > Window Management > Window Tiling.

⌨️ You can view the shortcuts in System Settings > Shortcuts > Window Tiling. If you used Krohnkite before, you can import some of its shortcuts using the bash script.

🔧 If you want, you may also make a couple of manual fixes and tweaks to improve your experience with window tiling. See Tweaks section.

Configuration

You can configure Bismuth in the System Settings > Window Management > Window Tiling.

Bismuth Configuration Module

🤝 Acknowledgments

This project was made possible because of the hard work of other people on Krohnkite KWin Tiling Script.