nix-community/plasma-manager
1
1
Fork 0
mirror of https://github.com/nix-community/plasma-manager.git synced 2024-07-07 04:56:27 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add some more info and some rewrites for the README (#231)

Browse Source
This commit is contained in:
magnouvean 2024-06-25 20:14:41 +02:00 committed by GitHub
parent a3b881f62e
commit 6054a1b0bc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -18,9 +18,13 @@ to configure KDE Plasma using Nix.
most up-to-date branch and is mainly focused on plasma 6, but may still work on
plasma 5. If you are running plasma 5, it's recommended to use the `plasma-5`
branch, which is designed to have better compatibility with plasma 5. To do this
with flakes you can use "github:nix-community/plasma-manager/plasma-5" as you flake
url, or if you are using nix-channels you can set the channel url to
"https://github.com/nix-community/plasma-manager/archive/plasma-5.tar.gz".
with flakes you can use "github:nix-community/plasma-manager/plasma-5" as your
flake url, or if you are using nix-channels you can set the channel url to
"https://github.com/nix-community/plasma-manager/archive/plasma-5.tar.gz". It's
worth noting that the plasma 5 branch, due to the extra work required for
maintaining, may lag behind a bit in features, but in general it should be less
broken when used with plasma 5. If you want the best experience with
`plasma-manager` it's recommended running plasma 6.
## What's supported
At the moment `plasma-manager` supports configuring the following:
@ -47,7 +51,6 @@ particular:
- Real-time updates of configuration without having to log out and back in
- Configuration of LibInput devices (see https://github.com/nix-community/plasma-manager/issues/47 and https://github.com/nix-community/plasma-manager/pull/123)
- Usage of high-level modules in the configuration generated by `rc2nix`
- Configuration of kwin window rules
- Keybindings to some key combinations (`Ctrl+Alt+T` and `Print` for example, see https://github.com/nix-community/plasma-manager/issues/109 and https://github.com/nix-community/plasma-manager/issues/136)
There may also be more things we aren't aware of. If you find some other
@ -113,13 +116,20 @@ nix run github:nix-community/plasma-manager
## Contributions and Maintenance
This is a community project and we welcome all contributions.
This is a community project and we welcome all contributions. KDE plasma and its
apps consists of a lot of configuration options, and if you find that some
options are missing and have the skills to implement this, PRs are very welcome.
Issues are also welcome for everything from feature-requests to bug-reports or
just general suggestions for improving the project.
## Special Thanks
This work was inspired by the suggestions on [Home Manager Issue #607][hm607] by
people such as [bew](https://github.com/bew) and
[kurnevsky](https://github.com/kurnevsky). Thank you.
`plasma-manager` started off it's development under
[pjones](https://github.com/pjones), whose contributions have laid the
foundation of the project to this day. The project was otherwise inspired by the
suggestions on [Home Manager Issue
#607][hm607] by people such as [bew](https://github.com/bew) and
[kurnevsky](https://github.com/kurnevsky). Thank you.
[home-manager]: https://github.com/nix-community/home-manager
[hm607]: https://github.com/nix-community/home-manager/issues/607