From 2e2e921538113c5de14c6eaf322611f718c73997 Mon Sep 17 00:00:00 2001 From: lambinsea Date: Sun, 22 Jun 2025 03:53:43 -0700 Subject: [PATCH] docs: fix readme grammar --- README.md | 56 +++++++++++++++++++++++++++---------------------------- 1 file changed, 28 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index e4c8e84..5bc023b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Maomaowm -This project is developed based on [dwl](https://codeberg.org/dwl/dwl/), +This project's development is based on [dwl](https://codeberg.org/dwl/dwl/). "Since many people have asked about the meaning of this compositor's name, 'Maomao' is an online alias I've been using for years - it comes from the first two characters of the Chinese word for 'caterpillar' (毛毛虫). You can basically think of it as meaning 'caterpillar'. @@ -8,16 +8,16 @@ This project is developed based on [dwl](https://codeberg.org/dwl/dwl/), - *Maomao* is as lightweight as *dwl*, and its build can be completed within few seconds. Despite this, *maomao* does not compromise on functionality. 2. **Feature Highlights** - - Besides basic WM functionality, maomao provides: - - Base tag not workspace(supports separate window layouts for each tag) - - Smooth and customizable complete animations(window open/move/close, tag enter/leave) - - Excellent input method support(text input v2/v3) - - Flexible window layouts with easy switching(scroller,master,monocle,spiral..etc) - - Rich window states(swallow, minimize, maximize, unglobal, global, fakefullscreen, overlay...etc) + - In addition to basic WM functionality, Maomao provides: + - Base tag not workspace (supports separate window layouts for each tag) + - Smooth and customizable complete animations (window open/move/close, tag enter/leave) + - Excellent input method support (text input v2/v3) + - Flexible window layouts with easy switching (scroller, master, monocle, spiral, etc.) + - Rich window states (swallow, minimize, maximize, unglobal, global, fakefullscreen, overlay, etc.) - Simple yet powerful external configuration - - Sway like scratchpad and named scratchpad + - Sway-like scratchpad and named scratchpad - Minimize window to scratchpad - - Hycov like overview + - Hycov-like overview Master-Stack Layout @@ -36,21 +36,21 @@ https://github.com/user-attachments/assets/c9bf9415-fad1-4400-bcdc-3ad2d76de85a - Spiral - Deck -# install +# Installation -## depend +## Dependencies ```bash yay -S glibc wayland libinput libdrm pixman libxkbcommon git meson ninja wayland-protocols libdisplay-info libliftoff hwdata seatd pcre2 ``` -## arch +## Arch Linux ```bash yay -S maomaowm-git ``` -## other +## Other ```bash # wlroots 0.19.0 release with a fix-patch to avoid crash git clone -b 0.19.0-fix https://github.com/DreamMaoMao/wlroots.git @@ -64,40 +64,40 @@ meson build -Dprefix=/usr sudo ninja -C build install ``` -## suggest tools +## Suggested Tools ``` yay -S rofi foot xdg-desktop-portal-wlr swaybg waybar wl-clip-persist cliphist wl-clipboard wlsunset xfce-polkit swaync ``` -## Some common default key bindings +## Some Common Default Keybindings - alt+return: open foot terminal - alt+q: kill client - alt+left/right/up/down: focus direction - super+m: quit maomao -## My dotfile -- depend +## My Dotfiles +- Dependencies ``` yay -S pamixer lavalauncher-mao-git wlr-dpms sway-audio-idle-inhibit-git swayidle dimland-git brightnessctl swayosd wlr-randr grim slurp satty swaylock-effects-git wlogout ``` -### maomao config +### Maomao Config [maomao-config](https://github.com/DreamMaoMao/dotfile/tree/main/maomao) -#### other +#### Other Tools [foot](https://github.com/DreamMaoMao/dotfile/tree/main/foot) [swaylock](https://github.com/DreamMaoMao/dotfile/tree/main/swaylock) [wlogout](https://github.com/DreamMaoMao/dotfile/tree/main/wlogout) [swaync](https://github.com/DreamMaoMao/dotfile/tree/main/swaync) -## Config document -refer to [wiki](https://github.com/DreamMaoMao/maomaowm/wiki/) +## Config Document +Refer to the [wiki](https://github.com/DreamMaoMao/maomaowm/wiki/) -# NixOS+Home-manager +# NixOS + Home-manager The repo contains a flake that provides a NixOS module and a home-manager module for maomaowm. -Use the NixOS module to install maomaowm with other necessary components of a working wayland environment. +Use the NixOS module to install maomaowm with other necessary components of a working Wayland environment. Use the home-manager module to declare configuration and autostart for maomaowm. Here's an example of using the modules in a flake: @@ -167,12 +167,12 @@ Here's an example of using the modules in a flake: } ``` -# thanks for some refer repo +# Thanks to These Reference Repositories -- 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 - basal window animaition +- https://github.com/dqrk0jeste/owl - Basal window animation -- https://codeberg.org/dwl/dwl - basal dwl feature +- https://codeberg.org/dwl/dwl - Basal dwl feature -- https://github.com/swaywm/sway - sample of wayland protocol +- https://github.com/swaywm/sway - Sample of Wayland protocol