From ebbd9eee3597c5a0dfef4bfff791ccd855cf2d31 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Fri, 30 Jan 2026 11:19:06 -0800 Subject: [PATCH] docs(readme): prepare to make repo public --- .github/FUNDING.yml | 2 ++ .github/pull_request_template.md | 7 +++++ CONTRIBUTING.md | 45 ++++++++++++++++++++++++++++++++ README.md | 37 +++++++++++++++++--------- 4 files changed, 79 insertions(+), 12 deletions(-) create mode 100644 .github/FUNDING.yml create mode 100644 .github/pull_request_template.md create mode 100644 CONTRIBUTING.md diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 00000000..756b5b9c --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: LGUG2Z +ko_fi: lgug2z \ No newline at end of file diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..5059bfde --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,7 @@ + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..7a3562e5 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,45 @@ +# Contributing to the Project + +The project is a collection of contributions from both the project leaders and +community members. There are many ways to contribute, this can include content +in the project repositories, as well as contributing in public and private +conversation, assisting users, writing blog posts, and many other ways. + +## How contributions are made + +Contributions to the project primarily happen in the project source +repositories, but may also occur in other places, such as discussion forums and +public and private discourse. + +## Contributing content to the Project + +In order for the project leaders to manage sustained progress toward the +project goals and maintain project velocity, focus and quality, the project may +adjust the license terms over time. + +Content contributed to the project must therefore be provided under +sufficiently liberal terms to allow these operations to proceed unimpeded. As +such contributions are accepted with the following understanding: + +* Contributed content is licensed under the terms of the 0-BSD license +* Contributors accept the terms of the project license at the time of + contribution + +By making a contribution, you accept both the current project license terms, +and that all contributions that you have made are provided under the terms of +the 0-BSD license. + +## Zero-Clause BSD + +``` +Permission to use, copy, modify, and/or distribute this software for +any purpose with or without fee is hereby granted. + +THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL +WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE +FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY +DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN +AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT +OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +``` \ No newline at end of file diff --git a/README.md b/README.md index 85e5dd50..e4c027cc 100644 --- a/README.md +++ b/README.md @@ -40,8 +40,19 @@ 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. +[LGUG2Z/komorebi-for-mac](https://github.com/LGUG2Z/komorebi-for-mac) is the +public repository where versioned releases will be published. + +[KomoCorp/komorebi-for-mac](https://github.com/KomoCorp/komorebi-for-mac) is the +private repository available to certain GitHub Sponsors tiers where ongoing +development work happens and nightly releases are made available. + +If you are reading this sentence on the public repository, _komorebi for Mac_ +has still not had its first versioned release. If you would like to try out this +initial public snapshot, you should [build from +source](https://komorebi-starlight.lgug2z.workers.dev/guides/installation/#building-from-source) +and follow the +[quickstart](https://komorebi-starlight.lgug2z.workers.dev/guides/quickstart/). ## Community @@ -116,13 +127,15 @@ Licenses [can be found here](https://lgug2z.com/software/komorebi). # Contribution Guidelines -_komorebi for Mac_ is currently not accepting contributions. +_komorebi for Mac_ is currently accepting minimally invasive bug fixes. +Proposals for any other kind of contributions can be discussed with me on +Discord. -[//]: # "If you would like to contribute to `komorebi` please take the time to carefully" -[//]: # "read the guidelines below." -[//]: # -[//]: # "Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information about how" -[//]: # "code contributions to `komorebi` are licensed." +If you would like to contribute to `komorebi` please take the time to carefully +read the guidelines below. + +Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more information about how +code contributions to `komorebi` are licensed. ## Commit hygiene @@ -250,14 +263,14 @@ handled events and messages as in the example above in the Named Pipes section. ## Rust Client -As of `v0.1.22` it is possible to use the `komorebi-client` crate to subscribe -to notifications of every `WindowManagerEvent` and `SocketMessage` handled by -`komorebi` in a Rust codebase. +It is possible to use the `komorebi-client` crate to subscribe to notifications +of every `WindowManagerEvent` and `SocketMessage` handled by `komorebi` in a +Rust codebase. Below is a simple example of how to use `komorebi-client` in a basic Rust application. ```rust -// komorebi-client = { git = "https://github.com/LGUG2Z/komorebi", tag = "v0.1.38"} +// komorebi-client = { git = "https://github.com/LGUG2Z/komorebi-for-mac" } use anyhow::Result; use komorebi_client::Notification;