update readme

update readme
This commit is contained in:
DreamMaoMao 2025-03-03 08:33:19 +08:00
parent 2082ef7581
commit 408e87d9d1

125
README.md
View file

@ -18,14 +18,14 @@ https://github.com/user-attachments/assets/c9bf9415-fad1-4400-bcdc-3ad2d76de85a
# Maomaowm
This project is developed based on `dwl(0.5)` ,
adding many operation that supported in hyprland and a hyprland-like keybinds,
niri-like scroll layout and sway-like scratchpad.
This project is developed based on `dwl` , it is basically compatible with all `dwm` features.
In addition, it is added many operation that supported in `hyprland`, such as `smooth and customizable animation``External configuration that can be hot overloaded`,`pin mode`,`maximize window` etc...
See below for more features.
# separate window layout for each workspace(tags), with separate workspace parameters
## support layout
- tile(master)
- tile
- scroller
- monocle
- grid
@ -48,17 +48,16 @@ See below for more features.
# some special feature
- hycov like overview
- foreign-toplevel support(dunst,waybar wlr taskbar)
- foreign-toplevel protocol(dunst,waybar wlr taskbar)
- minimize window to waybar(like hych)
- sway scratchpad support (minimize window to scratchpad)
- window pin mode support
- text-input-v2/v3 for fcitx5
- window move/open animaition
- workspace switch animaition
- fade in animation
- sway scratchpad (minimize window to scratchpad)
- window pin mode/ maximize mode
- text-input-v2/v3 protocol for fcitx5
- window move/open/close animaition
- workspaces(tags) switch animaition
- fade/fadeout animation
- alt-tab switch window like gnome
- niri like scroller layout
- fadeout animation
## suggest tools
```
@ -67,7 +66,10 @@ yay -S rofi foot xdg-desktop-portal-wlr swaybg waybar wl-clip-persist cliphist w
```
# install
# wlroots(0.17)
## stable - wlroots(0.17)
Since 0.18 has some bugs that affect the experience,
I chose the more stable 0.17.4.
```
git clone -b 0.17.4 https://gitlab.freedesktop.org/wlroots/wlroots.git
cd wlroots
@ -79,12 +81,18 @@ cd maomaowm
meson build -Dprefix=/usr
sudo ninja -C build install
# set your autostart app ih this
mkdir -p ~/.config/maomao/
```
## unstable wlroots(0.19)
This is the latest version of wlroots, it doesn't own enough test.
you can try it out if you want to help to test.
```
yay -S wlroots-git
git clone -b wlroots-0.19 https://github.com/DreamMaoMao/maomaowm.git
cd maomaowm
meson build -Dprefix=/usr
sudo ninja -C build install
```
# config
you can use `MAOMAOCONFIG` env to set the config-folder-path and the autostart-folder-patch
@ -133,6 +141,79 @@ You can design your animaition curve in:
or you can just choice a curve in:
[easings.net](https://easings.net).
# overview mode
```
hotarea_size=10
enable_hotarea=1
ov_tab_mode=0
```
- enable_hotarea: when your cursor enter the bottom left corner of monitor, it will toggle overview.
- hotarea_size: the size of hotarea, 10x10 default.
- ov_tab_mode:
- it will circle switch focus when you toggle overview.
- and will leave ov mode when you release your mod key.
### notice
when you in ov mode, you can use right mouse button to close window, and left mouse button to jump to a window.
# About warbar
- you can also use the dwl moudle in waybar to show tags and window title
refer to waybar wiki: [dwl-module](https://github.com/Alexays/Waybar/wiki/Module:-Dwl)
```json
"modules-left": ["dwl/tags","dwl/window"],
"dwl/tags": {
"num-tags":9,
},
```
```css
#tags{
background-color: transparent;
}
#tags button{
background-color: #fff ;
color: #a585cd ;
}
#tags button.occupied{
background-color: #fff ;
color: #cdc885 ;
}
#tags button.focused{
background-color: rgb(186, 142, 213);
color: #fff ;
}
#tags button.urgent{
background: rgb(171, 101, 101);
color: #fff;
}
#window{
background-color: rgb(237, 196, 147);
color: rgb(63, 37, 5);
}
window#waybar.empty #window {
background-color: transparent;
color: transparent;
border-bottom:none;
box-shadow: none;
padding-right: 0px;
padding-left: 0px;
margin-left: 0px;
margin-right: 0px;
}
```
# NixOS+Home-manager
```nix
{
@ -200,12 +281,12 @@ or you can just choice a curve in:
# thanks for some refer repo
- https://gitlab.freedesktop.org/wlroots/wlroots - Implementation of wayland protocol
- https://gitlab.freedesktop.org/wlroots/wlroots - implementation of wayland protocol
- https://github.com/dqrk0jeste/owl - for basal window animaition
- https://github.com/dqrk0jeste/owl - basal window animaition
- https://github.com/djpohly/dwl - for basal dwl feature
- https://github.com/djpohly/dwl - basal dwl feature
- https://github.com/guyuming76/dwl - for text-input
- https://github.com/guyuming76/dwl - sample of text-input protocol
- https://github.com/swaywm/sway - for foreign-toplevel
- https://github.com/swaywm/sway - sample of wayland protocol