mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-15 21:32:26 +01:00
LGUG2Z
629cb19580
README.md: the note "komorebi for Mac lives here" (a link to the old repository) is replaced by a "Platforms" section: the three platforms with their daemon library, documentation (docs/linux/README.md, docs/macos/README.md) and schemas directory, and a sentence that where the repository is published and where the releases and sites live is not decided yet. The SocketMessage link pointed at komorebi/src/core/mod.rs#L37 of the old upstream repository; it is now a relative link to crates/komorebi-protocol/src/message.rs, where the enum lives. CONTRIBUTING.md: a first line links the contribution guides of the Linux and macOS ports. The link to the old komorebi-for-mac repository is kept as history; nothing else of the README (it is the Windows README) was changed. Verified: the relative links resolve (link checker over the repository markdown).
55 lines
2.4 KiB
Markdown
55 lines
2.4 KiB
Markdown
The Linux and macOS ports have contribution guides of their own: [`docs/linux/CONTRIBUTING.md`](docs/linux/CONTRIBUTING.md) and [`docs/macos/CONTRIBUTING.md`](docs/macos/CONTRIBUTING.md).
|
|
|
|
# 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.
|
|
```
|
|
|
|
## Developer documentation
|
|
|
|
How the repository is laid out after the consolidation of the Windows, KDE
|
|
Plasma and macOS trees is in `docs/dev/ARCHITECTURE-UNIFIED.md`; the exact
|
|
build, test, e2e and VM commands for each platform, and the known flakes, are
|
|
in `docs/dev/build-and-test.md`.
|