mirror/swaysome
1
0
Fork 0
mirror of https://gitlab.com/hyask/swaysome.git synced 2025-12-10 07:44:43 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

README: improved description to include workspace groups

Browse source
This commit is contained in:
Skia 2023-03-03 17:50:21 +01:00
parent 7daf8ffd77
commit 7b3de58cd9
1 changed files with 35 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -1,11 +1,41 @@
# Swaysome
This binary helps you configure sway to work a bit more like Awesome. This
currently means workspaces that are name-spaced on a per-screen basis.
## Description
It may also work with i3, but this is untested.
This binary helps you configure sway to work a bit more like [AwesomeWM](https://awesomewm.org/). This currently means
workspaces that are name-spaced on a per-screen basis.
example: with workspace `11` on the first screen, and workspace `21` on the second screen, typing the `swaysome`
shortcut to get workspace `1` would lead you to workspace `11` if your focus is on the first screen, and workspace `21`
is the focus is on the second one.
*swaysome* should be compatible with [sworkstyle](https://lib.rs/crates/sworkstyle).
`swaysome` also supports what we call "workspace groups". These are groups of workspaces sharing the same tens number
and tied to an output.
By default, `swaysome init` will create a workspace group per active output, but you may create other groups while working.
Here is a common use-case for this:
* `output-1`:
* workspace group 1:
* workspace `11`: chats
* workspace `12`: emails
* `output-2`:
* workspace group 2:
* workspace `21`: IDE for first project
* workspace `22`: browser for first project
* workspace `23`: terminals for first project
* workspace group 3:
* workspace `31`: IDE for second project
* workspace `32`: browser for second project
* workspace `33`: terminals for second project
That way, when `output-2` is focused on workspace group 2, be it workspace `21` or `22`, the quick `$mod+<number>`
shortcut won't leave workspace group 2, allowing you to open multiple projects in parallel without the hassle of
manually remembering how to namespace them.
`swaysome` may also work with i3, but this is untested.
`swaysome` should be compatible with [sworkstyle](https://lib.rs/crates/sworkstyle).
## Installation
@ -156,6 +186,7 @@ as usual.
* `init [name]`: cycle all outputs to create a default workspace with name `[name]`
* `rearrange-workspaces` Rearrange already opened workspaces to the correct outputs, useful when plugging or unplugging screens
## Breaking changes
* Starting with 2.0, `next_output` and `prev_output` have been changed to `next-output` and `prev-output`.