mirror of
https://github.com/DreamMaoMao/maomaowm.git
synced 2026-03-06 01:40:45 -05:00
update readme
This commit is contained in:
DreamMaoMao
parent
794e96d194
commit
e9b8e1aa58
1 changed files with 23 additions and 23 deletions
46
README.md
46
README.md
|
|
@ -1,6 +1,6 @@
|
|||
# Mango Wayland Compositor
|
||||
<div>
|
||||
<img src="https://github.com/DreamMaoMao/mangowc/blob/main/assets/mango-transparency-256.png" alt="MangoWC Logo" width="120"/>
|
||||
<img src="https://github.com/mangowm/mango/blob/main/assets/mango-transparency-256.png" alt="MangoWM Logo" width="120"/>
|
||||
</div>
|
||||
|
||||
This project's development is based on [dwl](https://codeberg.org/dwl/dwl/).
|
||||
|
|
@ -36,7 +36,7 @@ https://github.com/user-attachments/assets/bb83004a-0563-4b48-ad89-6461a9b78b1f
|
|||
**Mango won't cater to every user preference**: For niche feature requests, I'll take a wait-and-see approach. I'll only consider adding them if they get a significant number of upvotes.
|
||||
|
||||
# Our discord
|
||||
[mangowc](https://discord.gg/CPjbDxesh5)
|
||||
[mangowm](https://discord.gg/CPjbDxesh5)
|
||||
|
||||
# Supported layouts
|
||||
- tile
|
||||
|
|
@ -52,7 +52,7 @@ https://github.com/user-attachments/assets/bb83004a-0563-4b48-ad89-6461a9b78b1f
|
|||
|
||||
# Installation
|
||||
|
||||
[](https://repology.org/project/mangowc/versions)
|
||||
[](https://repology.org/project/mangowm/versions)
|
||||
|
||||
## Dependencies
|
||||
|
||||
|
|
@ -71,9 +71,9 @@ https://github.com/user-attachments/assets/bb83004a-0563-4b48-ad89-6461a9b78b1f
|
|||
- libxcb
|
||||
|
||||
## Arch Linux
|
||||
The package is in the Arch User Repository and is available for manual download [here](https://aur.archlinux.org/packages/mangowc-git) or through a AUR helper like yay:
|
||||
The package is in the Arch User Repository and is available for manual download [here](https://aur.archlinux.org/packages/mangowm-git) or through a AUR helper like yay:
|
||||
```bash
|
||||
yay -S mangowc-git
|
||||
yay -S mangowm-git
|
||||
|
||||
```
|
||||
|
||||
|
|
@ -87,12 +87,12 @@ eselect repository enable guru
|
|||
emerge --sync guru
|
||||
```
|
||||
|
||||
Then, add `gui-libs/scenefx` and `gui-wm/mangowc` to the `package.accept_keywords`.
|
||||
Then, add `gui-libs/scenefx` and `gui-wm/mangowm` to the `package.accept_keywords`.
|
||||
|
||||
Finally, install the package:
|
||||
|
||||
```bash
|
||||
emerge --ask --verbose gui-wm/mangowc
|
||||
emerge --ask --verbose gui-wm/mangowm
|
||||
```
|
||||
|
||||
## Fedora Linux
|
||||
|
|
@ -102,32 +102,32 @@ First, add the [Terra Repository](https://terra.fyralabs.com/).
|
|||
Then, install the package:
|
||||
|
||||
```bash
|
||||
dnf install mangowc
|
||||
dnf install mangowm
|
||||
```
|
||||
|
||||
## Guix System
|
||||
The package definition is described in the source repository.
|
||||
First, add `mangowc` channel to `channels.scm` file:
|
||||
First, add `mangowm` channel to `channels.scm` file:
|
||||
|
||||
```scheme
|
||||
;; In $HOME/.config/guix/channels.scm
|
||||
(cons (channel
|
||||
(name 'mangowc)
|
||||
(url "https://github.com/DreamMaoMao/mangowc.git")
|
||||
(name 'mangowm)
|
||||
(url "https://github.com/mangowm/mango.git")
|
||||
(branch "main"))
|
||||
... ;; Your other channels
|
||||
%default-channels)
|
||||
```
|
||||
|
||||
Then, run `guix pull` and after update you can either run
|
||||
`guix install mangowc` or add it to your configuration via:
|
||||
`guix install mangowm` or add it to your configuration via:
|
||||
|
||||
```scheme
|
||||
(use-modules (mangowc)) ;; Add mangowc module
|
||||
(use-modules (mangowm)) ;; Add mangowm module
|
||||
|
||||
;; Add mangowc to packages list
|
||||
;; Add mangowm to packages list
|
||||
(packages (cons*
|
||||
mangowc-git
|
||||
mangowm-git
|
||||
... ;; Other packages you specified
|
||||
%base-packages))
|
||||
```
|
||||
|
|
@ -147,8 +147,8 @@ cd scenefx
|
|||
meson build -Dprefix=/usr
|
||||
sudo ninja -C build install
|
||||
|
||||
git clone https://github.com/DreamMaoMao/mangowc.git
|
||||
cd mangowc
|
||||
git clone https://github.com/mangowm/mango.git
|
||||
cd mangowm
|
||||
meson build -Dprefix=/usr
|
||||
sudo ninja -C build install
|
||||
```
|
||||
|
|
@ -206,9 +206,9 @@ git clone https://github.com/DreamMaoMao/mango-config.git ~/.config/mango
|
|||
|
||||
## Config Documentation
|
||||
|
||||
Refer to the repo wiki [wiki](https://github.com/DreamMaoMao/mango/wiki/)
|
||||
Refer to the repo wiki [wiki](https://github.com/mangowm/mango/wiki/)
|
||||
|
||||
or the website docs [docs](https://mangowc.vercel.app/docs)
|
||||
or the website docs [docs](https://mangowm.vercel.app/docs)
|
||||
|
||||
# NixOS + Home-manager
|
||||
|
||||
|
|
@ -228,7 +228,7 @@ Here's an example of using the modules in a flake:
|
|||
};
|
||||
flake-parts.url = "github:hercules-ci/flake-parts";
|
||||
mango = {
|
||||
url = "github:DreamMaoMao/mango";
|
||||
url = "github:mangowm/mango";
|
||||
inputs.nixpkgs.follows = "nixpkgs";
|
||||
};
|
||||
};
|
||||
|
|
@ -290,9 +290,9 @@ Here's an example of using the modules in a flake:
|
|||
|
||||
To package mango for other distributions, you can check the reference setup for:
|
||||
|
||||
- [nix](https://github.com/DreamMaoMao/mangowc/blob/main/nix/default.nix)
|
||||
- [arch](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=mangowc-git).
|
||||
- [gentoo](https://data.gpo.zugaina.org/guru/gui-wm/mangowc)
|
||||
- [nix](https://github.com/mangowm/mango/blob/main/nix/default.nix)
|
||||
- [arch](https://aur.archlinux.org/cgit/aur.git/tree/PKGBUILD?h=mangowm-git).
|
||||
- [gentoo](https://data.gpo.zugaina.org/guru/gui-wm/mangowm)
|
||||
|
||||
You might need to package `scenefx` for your distribution, check availability [here](https://github.com/wlrfx/scenefx.git).
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue