mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-16 05:41:16 +01:00
docs(readme): prepare to make repo public
This commit is contained in:
1 parent
72ec96c2f6
commit
ebbd9eee35
4 files changed
+79
-12
No files matched your search
@@ -0,0 +1,2 @@
|
||||
github: LGUG2Z
|
||||
ko_fi: lgug2z
|
||||
@@ -0,0 +1,7 @@
|
||||
<!--
|
||||
Please follow the Conventional Commits specification.
|
||||
|
||||
If you need to update your PR with changes from `master`, please run `git rebase master`.
|
||||
|
||||
By opening this PR, you confirm that you have read, understood and agree to this project's `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.
|
||||
```
|
||||
@@ -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;
|
||||
|
||||
Reference in new issue
Block a user