mirrors/maomaowm
1
0
Fork 0
mirror of https://github.com/DreamMaoMao/maomaowm.git synced 2025-10-29 05:40:21 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

doc: add documentation for the nixos module

Browse source
This commit is contained in:
EdenQwQ 2025-03-24 12:50:27 +08:00
parent aeffd46b64
commit 982827cb8e
1 changed files with 15 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -250,6 +250,12 @@ refer to [ipc](https://github.com/DreamMaoMao/mmsg)
# 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 home-manager module to declare configuration and autostart for maomaowm.
Here's an example of using the modules in a flake:
```nix ```nix
{ {
inputs = { inputs = {
@ -260,7 +266,6 @@ refer to [ipc](https://github.com/DreamMaoMao/mmsg)
}; };
flake-parts.url = "github:hercules-ci/flake-parts"; flake-parts.url = "github:hercules-ci/flake-parts";
maomaowm.url = "github:DreamMaoMao/maomaowm"; maomaowm.url = "github:DreamMaoMao/maomaowm";
}; };
outputs = outputs =
inputs@{ self, flake-parts, ... }: inputs@{ self, flake-parts, ... }:
@ -273,6 +278,15 @@ refer to [ipc](https://github.com/DreamMaoMao/mmsg)
system = "x86_64-linux"; system = "x86_64-linux";
modules = [ modules = [
inputs.home-manager.nixosModules.home-manager inputs.home-manager.nixosModules.home-manager
# Add maomaowm nixos module
inputs.maomaowm.nixosModules.maomaowm
{
programs.maomaowm.enable = true;
# mmsg is the ipc for maomamwm and is enabled by default
programs.maomaowm.mmsg.enable = true;
}
{ {
home-manager = { home-manager = {
useGlobalPkgs = true; useGlobalPkgs = true;