Files
komorebi/README.md
T
2025-09-16 16:53:11 -07:00

112 lines
5.1 KiB
Markdown

# komorebi for Mac
Tiling Window Management for macOS.
<p>
<a href="https://techforpalestine.org/learn-more">
<img alt="Tech for Palestine" src="https://badge.techforpalestine.org/default">
</a>
[//]: # ' <img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/LGUG2Z/komorebi-for-mac/.github/workflows/windows.yaml">'
[//]: # ' <img alt="GitHub all releases" src="https://img.shields.io/github/downloads/LGUG2Z/komorebi-for-mac/total">'
[//]: # ' <img alt="GitHub commits since latest release (by date) for a branch" src="https://img.shields.io/github/commits-since/LGUG2Z/komorebi-for-mac/latest">'
<img alt="Active Individual Commercial Use Licenses" src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Flgug2z-ecstaticmagentacheetah.web.val.run&query=%24.&label=active%20individual%20commercial%20use%20licenses&cacheSeconds=3600&link=https%3A%2F%2Flgug2z.com%2Fsoftware%2Fkomorebi">
<a href="https://discord.gg/mGkn66PHkx">
<img alt="Discord" src="https://img.shields.io/discord/898554690126630914">
</a>
<a href="https://github.com/sponsors/LGUG2Z">
<img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/LGUG2Z">
</a>
<a href="https://ko-fi.com/lgug2z">
<img alt="Ko-fi" src="https://img.shields.io/badge/kofi-tip-green">
</a>
<a href="https://notado.app/feeds/jado/software-development">
<img alt="Notado Feed" src="https://img.shields.io/badge/Notado-Subscribe-informational">
</a>
<a href="https://www.youtube.com/channel/UCeai3-do-9O4MNy9_xjO6mg?sub_confirmation=1">
<img alt="YouTube" src="https://img.shields.io/youtube/channel/subscribers/UCeai3-do-9O4MNy9_xjO6mg">
</a>
</p>
## Overview
_komorebi for Mac_ is a tiling window manager that works as an extension to the
standard macOS desktop environment.
_komorebi for Mac_ aims to make _as few modifications as possible_ to the
operating system and desktop environment by default.
_komorebi for Mac_ is currently under development, and this repository is
currently restricted to sponsors.
## Community
There is a [Discord server](https://discord.gg/mGkn66PHkx) available for
_komorebi_-related discussion, help, troubleshooting etc. If you have any
specific feature requests or bugs to report, please create an issue in this
repository.
There is
a [YouTube channel](https://www.youtube.com/channel/UCeai3-do-9O4MNy9_xjO6mg)
where I post _komorebi_ development videos, feature previews and release
overviews. Subscribing to the channel (which is monetized as part of the YouTube
Partner Program) and watching videos is a really simple and passive way to
contribute financially to the development and maintenance of _komorebi_.
There is an [Awesome List](https://github.com/LGUG2Z/awesome-komorebi) which
showcases the many awesome projects that exist in the _komorebi_ ecosystem.
## Licensing for Personal Use
`komorebi`
is [educational source software](https://lgug2z.com/articles/educational-source-software/).
`komorebi` is licensed under
the [Komorebi 2.0.0 license](https://github.com/LGUG2Z/komorebi-license), which
is a fork of
the [PolyForm Strict 1.0.0 license](https://polyformproject.org/licenses/strict/1.0.0).
On a high level this means that you are free to do whatever you want with
`komorebi` for personal use other than redistribution, or distribution of new
works (i.e. hard-forks) based on the software.
Anyone is free to make their own fork of `komorebi` with changes intended either
for personal use or for integration back upstream via pull requests.
The [Komorebi 2.0.0 License](https://github.com/LGUG2Z/komorebi-license) does
not permit any kind of commercial use ( i.e. using `komorebi` at work).
## Sponsorship for Personal Use
_komorebi for Mac_ is a free and educational source project, and one that
encourages you to make charitable donations if you find the software to be
useful and have the financial means.
I encourage you to make a charitable donation to
the [Palestine Children's Relief Fund](https://pcrf1.app.neoncrm.com/forms/gaza-recovery)
or to contribute to a [Gaza Funds campaign](https://gazafunds.com) before you
consider sponsoring me on GitHub.
[GitHub Sponsors is enabled for this project](https://github.com/sponsors/LGUG2Z).
Sponsors can claim custom roles on the Discord server, get shout outs at the end
of _komorebi_-related videos on YouTube, gain the ability to submit feature
requests on the issue tracker, and receive releases of komorebi with "easter
eggs" on physical media.
If you would like to tip or sponsor the project but are unable to use GitHub
Sponsors, you may also sponsor through [Ko-fi](https://ko-fi.com/lgug2z), or
make an anonymous Bitcoin donation to
`bc1qv73wzspc77k46uty4vp85x8sdp24mphvm58f6q`.
## Licensing for Commercial Use
A dedicated Individual Commercial Use License will eventually be made available
for those who want to use `komorebi` at work.
The Individual Commerical Use License will add “Commercial Use” as a “Permitted
Use” for the licensed individual only, for the duration of a valid paid license
subscription only. All provisions and restrictions enumerated in
the [Komorebi License](https://github.com/LGUG2Z/komorebi-license) will continue
to apply.