mirror of
https://github.com/winapps-org/winapps.git
synced 2025-09-23 17:59:34 +02:00
feat: add dco
Signed-off-by: Oskar Manhart <52569953+oskardotglobal@users.noreply.github.com>
This commit is contained in:
@@ -1,8 +0,0 @@
|
|||||||
# Contribution Guidelines
|
|
||||||
|
|
||||||
Thank you for contributing to winapps! Before you can contribute, we ask some things of you:
|
|
||||||
|
|
||||||
- Please follow our Code of Conduct, the Contributor Covenant. You can find a copy in this repository or under https://www.contributor-covenant.org/
|
|
||||||
- All Contributors have to sign [a CLA](https://gist.github.com/oskardotglobal/35f0a72eb45fcc7087e535561383dbc5) for legal reasons. When opening a PR, @cla-assistant will prompt you and guide you through the process. However, if you contribute on behalf of a legal entity, we ask of you to sign [a different CLA](https://gist.github.com/oskardotglobal/75a8cc056e56a439fa6a1551129ae47f). In that case, please contact us.
|
|
||||||
- Please follow code conventions enforced by `pre-commit`. To keep down CI usage, please run it locally before committing too.
|
|
||||||
See <https://pre-commit.com> for installation, then run `pre-commit install` inside the `winapps` repository you cloned.
|
|
@@ -6,7 +6,7 @@ The original project by Fmstrat <https://github.com/Fmstrat/winapps/> is not fre
|
|||||||
Due to lack of a license, it is All Rights Reserved by the original author.
|
Due to lack of a license, it is All Rights Reserved by the original author.
|
||||||
|
|
||||||
We have tried contacting Fmstrat about this, but they abandoned the project and did not reply nor apply an open-source license to the project.
|
We have tried contacting Fmstrat about this, but they abandoned the project and did not reply nor apply an open-source license to the project.
|
||||||
However, almost all parts of the codebase have been rewritten and all new contributions require a Contributor License Agreement ([for individuals](https://gist.github.com/oskardotglobal/35f0a72eb45fcc7087e535561383dbc5), [for legal entities](https://gist.github.com/oskardotglobal/75a8cc056e56a439fa6a1551129ae47f)) to be signed. Therefore, the below license is applied to all new contributions made to the project.
|
However, almost all parts of the codebase have been rewritten and all new contributions require signing a Developer Certificate of Origin (or historically, a CLA; see [CONTRIBUTING.md](./CONTRIBUTING.md)), making most parts of the codebase AGPLv3.
|
||||||
|
|
||||||
Refer to a specific file for its respective license.
|
Refer to a specific file for its respective license.
|
||||||
|
|
||||||
|
12
README.md
12
README.md
@@ -1,10 +1,10 @@
|
|||||||
<p align="center"><img align="center" width="700" src="./icons/banner_dark.svg#gh-dark-mode-only"/></p>
|
<p align="center"><img align="center" width="700" src="./docs/readme/banner_dark.svg#gh-dark-mode-only"/></p>
|
||||||
<p align="center"><img align="center" width="700" src="./icons/banner_light.svg#gh-light-mode-only"/></p>
|
<p align="center"><img align="center" width="700" src="./docs/readme/banner_light.svg#gh-light-mode-only"/></p>
|
||||||
<hr>
|
<hr>
|
||||||
|
|
||||||
Run Windows applications (including [Microsoft 365](https://www.microsoft365.com/) and [Adobe Creative Cloud](https://www.adobe.com/creativecloud.html)) on GNU/Linux with `KDE Plasma`, `GNOME` or `XFCE`, integrated seamlessly as if they were native to the OS.
|
Run Windows applications (including [Microsoft 365](https://www.microsoft365.com/) and [Adobe Creative Cloud](https://www.adobe.com/creativecloud.html)) on GNU/Linux with `KDE Plasma`, `GNOME` or `XFCE`, integrated seamlessly as if they were native to the OS.
|
||||||
|
|
||||||
<p align="center"><img src="./demo/demo.png" width=1000 alt="WinApps Demonstration."></p>
|
<p align="center"><img src="./docs/readme/demo.png" width=1000 alt="WinApps Demonstration."></p>
|
||||||
|
|
||||||
## Underlying Mechanism
|
## Underlying Mechanism
|
||||||
WinApps works by:
|
WinApps works by:
|
||||||
@@ -275,7 +275,7 @@ Contributing to the list of supported applications is encouraged through submiss
|
|||||||
<tr>
|
<tr>
|
||||||
<!-- Windows -->
|
<!-- Windows -->
|
||||||
<td>
|
<td>
|
||||||
<img src="icons/windows.svg" width="100">
|
<img src="install/windows.svg" width="100">
|
||||||
</td>
|
</td>
|
||||||
<td>
|
<td>
|
||||||
<b>Windows</b><br>
|
<b>Windows</b><br>
|
||||||
@@ -558,7 +558,7 @@ bash <(curl https://raw.githubusercontent.com/winapps-org/winapps/main/setup.sh)
|
|||||||
|
|
||||||
Once WinApps is installed, a list of additional arguments can be accessed by running `winapps-setup --help`.
|
Once WinApps is installed, a list of additional arguments can be accessed by running `winapps-setup --help`.
|
||||||
|
|
||||||
<img src="./demo/installer.gif" width=1000 alt="WinApps Installer Animation.">
|
<img src="./docs/readme/installer.gif" width=1000 alt="WinApps Installer Animation.">
|
||||||
|
|
||||||
## Adding Additional Pre-defined Applications
|
## Adding Additional Pre-defined Applications
|
||||||
Adding your own applications with custom icons and MIME types to the installer is easy. Simply copy one of the application configurations in the `apps` folder located within the WinApps repository, and:
|
Adding your own applications with custom icons and MIME types to the installer is easy. Simply copy one of the application configurations in the `apps` folder located within the WinApps repository, and:
|
||||||
@@ -584,7 +584,7 @@ The installer can be run multiple times. To update your installation of WinApps:
|
|||||||
## WinApps Launcher (Optional)
|
## WinApps Launcher (Optional)
|
||||||
The [WinApps Launcher](https://github.com/winapps-org/winapps-launcher) provides a simple system tray menu that makes it easy to launch your installed Windows applications, open a full desktop RDP session, and control your Windows VM or container. You can start, stop, pause, reboot or hibernate Windows, as well as access your installed applications from a convenient list. This lightweight, optional tool helps streamline your overall WinApps experience.
|
The [WinApps Launcher](https://github.com/winapps-org/winapps-launcher) provides a simple system tray menu that makes it easy to launch your installed Windows applications, open a full desktop RDP session, and control your Windows VM or container. You can start, stop, pause, reboot or hibernate Windows, as well as access your installed applications from a convenient list. This lightweight, optional tool helps streamline your overall WinApps experience.
|
||||||
|
|
||||||
<img src="./demo/launcher.gif" width=1000 alt="WinApps Launcher Animation.">
|
<img src="./docs/readme/launcher.gif" width=1000 alt="WinApps Launcher Animation.">
|
||||||
|
|
||||||
## Installation using Nix
|
## Installation using Nix
|
||||||
|
|
||||||
|
60
docs/CONTRIBUTING.md
Normal file
60
docs/CONTRIBUTING.md
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
# Contribution Guidelines
|
||||||
|
|
||||||
|
Thank you for contributing to winapps! Before you can contribute, we ask some things of you:
|
||||||
|
|
||||||
|
- Please follow our Code of Conduct, the Contributor Covenant. You can find a copy in this repository or under https://www.contributor-covenant.org/
|
||||||
|
- All Contributors have to sign a Developer Certificate of Origin, agreeing to license their contribution under the AGPLv3. Historically, we used to require a CLA because we had to relicense the codebase from ARR to AGPLv3; however, this is being phased out. You can find a copy of the DCO below or under https://developercertificate.org/.
|
||||||
|
- Please follow code conventions enforced by `pre-commit`. To keep down CI usage, please run it locally before committing too.
|
||||||
|
See <https://pre-commit.com> for installation, then run `pre-commit install` inside the `winapps` repository you cloned.
|
||||||
|
|
||||||
|
## Guidelines for pre-defined applications
|
||||||
|
|
||||||
|
Some pre-defined applications contain a header like:
|
||||||
|
|
||||||
|
```
|
||||||
|
# Copyright (c) 2024 Fmstrat
|
||||||
|
# All rights reserved.
|
||||||
|
#
|
||||||
|
# SPDX-License-Identifier: Proprietary
|
||||||
|
```
|
||||||
|
|
||||||
|
This is for historic reasons, see [LICENSE.md](../LICENSE.md) and [COPYRIGHT.md](../COPYRIGHT.md).
|
||||||
|
When contributing new applications, please *do not* include such a header.
|
||||||
|
|
||||||
|
## Developer Certificate of Origin
|
||||||
|
|
||||||
|
Developer Certificate of Origin
|
||||||
|
Version 1.1
|
||||||
|
|
||||||
|
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
|
||||||
|
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies of this
|
||||||
|
license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
|
||||||
|
Developer's Certificate of Origin 1.1
|
||||||
|
|
||||||
|
By making a contribution to this project, I certify that:
|
||||||
|
|
||||||
|
(a) The contribution was created in whole or in part by me and I
|
||||||
|
have the right to submit it under the open source license
|
||||||
|
indicated in the file; or
|
||||||
|
|
||||||
|
(b) The contribution is based upon previous work that, to the best
|
||||||
|
of my knowledge, is covered under an appropriate open source
|
||||||
|
license and I have the right under that license to submit that
|
||||||
|
work with modifications, whether created in whole or in part
|
||||||
|
by me, under the same open source license (unless I am
|
||||||
|
permitted to submit under a different license), as indicated
|
||||||
|
in the file; or
|
||||||
|
|
||||||
|
(c) The contribution was provided directly to me by some other
|
||||||
|
person who certified (a), (b) or (c) and I have not modified
|
||||||
|
it.
|
||||||
|
|
||||||
|
(d) I understand and agree that this project and the contribution
|
||||||
|
are public and that a record of the contribution (including all
|
||||||
|
personal information I submit with it, including my sign-off) is
|
||||||
|
maintained indefinitely and may be redistributed consistent with
|
||||||
|
this project or the open source license(s) involved.
|
||||||
|
|
Reference in New Issue
Block a user