doc: added README and empty CLA

.github/workflows/cla.yml

@@ -0,0 +1,42 @@
+name: "CLA Assistant"
+on:
+  issue_comment:
+    types: [ created ]
+  pull_request_target:
+    types: [ opened,closed,synchronize ]
+
+# explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings
+permissions:
+  actions: write
+  contents: write # this can be 'read' if the signatures are in remote repository
+  pull-requests: write
+  statuses: write
+
+jobs:
+  CLAAssistant:
+    runs-on: ubuntu-latest
+    steps:
+      - name: "CLA Assistant"
+        if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I hereby sign the CLA') || github.event_name == 'pull_request_target'
+        uses: contributor-assistant/github-action@ca4a40a7d1004f18d9960b404b97e5f30a505a08
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # the below token should have repo scope and must be manually added by you in the repository's secret
+          # This token is required only if you have configured to store the signatures in a remote repository/organization
+          PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+        with:
+          path-to-signatures: 'signatures/version1/cla.json'
+          path-to-document: 'https://github.com/fraunhofer-iem/spha/blob/main/CLA.md' # e.g. a CLA or a DCO document
+          # branch should not be protected
+          branch: 'main'
+
+          # the followings are the optional inputs - If the optional inputs are not given, then default values will be taken
+          remote-organization-name: fraunhofer-iem # enter the remote organization name where the signatures should be stored (Default is storing the signatures in the same repository)
+          remote-repository-name: spha-cla # enter the  remote repository name where the signatures should be stored (Default is storing the signatures in the same repository)
+          create-file-commit-message: 'feat: Creating file for storing CLA Signatures'
+          signed-commit-message: '$contributorName has signed the CLA in $owner/$repo#$pullRequestNo'
+          #custom-notsigned-prcomment: 'pull request comment with Introductory message to ask new contributors to sign'
+          custom-pr-sign-comment: 'I have read the CLA Document and I hereby sign the CLA. Further, I agree to the storage of my GitHub account information in the signature file in github.com/fraunhofer-iem/spha-cla.'
+          #custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.'
+          lock-pullrequest-aftermerge: true # - if you don't want this bot to automatically lock the pull request after merging (default - true)
+          #use-dco-flag: true - If you are using DCO instead of CLA

CLA.md

@@ -0,0 +1,42 @@
+# Fraunhofer IEM Contributor License Agreement
+
+Thank you for your interest in contributing to the open-source software project Software Product Health Assistant (hereinafter referred to as “the Project”) maintained by Fraunhofer Institute for Mechatronic Systems Design IEM (hereafter “us” or “IEM”).
+
+The purpose of this Contributor Agreement ("Agreement") is to clarify the intellectual property license granted by persons or entities who provide code to IEM. When the Contribution is made on behalf of an entity, the term "you" in this Agreement means both the person accepting this Agreement and the entity that employs that person.
+This license is for your protection as a Contributor as well as the protection of Fraunhofer IEM and its users; it does not change your rights to use your own Contributions for any other purpose.
+
+**You hereby agree to the following terms and conditions:**
+
+## 1. Contributions
+The term "Contribution" means any code, documentation or other original works of authorship including any modifications or additions to an existing work. A Contribution is considered "submitted" if it is sent to the Project in electronic, oral or written form, including but not limited to communications on electronic mailing lists, source code control systems and issue tracking systems maintained by or on behalf of the Project for the purpose of discussing or improving the software or documentation of the Project. Communications clearly marked "Not a Contribution" or designated as such by you in writing shall not be deemed to be Contributions. Any Contribution submitted by you to the Project is subject to the terms and conditions of this Agreement without any additional terms or conditions.
+
+## 2. Licenses
+a) Grant of Copyright License.
+You grant IEM and the recipients of software distributed by IEM a perpetual, worldwide, non-exclusive, no-charge, royalty-free, and irrevocable license to reproduce, prepare derivative works of, publicly display, publicly perform and distribute the Contribution and to reproduce, prepare, publicly display, publicly perform and distribute such derivative works and sublicense all or any of the foregoing rights to.
+
+b) Grant of Patent License
+With respect to all patents owned by you, you hereby grant IEM and the recipients of software distributed by IEM a perpetual, irrevocable, non-exclusive, worldwide, fully paid-up, royalty-free patent license to make, have made, use all or any part of your Contribution, offer for sale, sell, import and otherwise transfer, alone or in combination with any product, work, derivative works or materials resulting from the Project, where such license applies only to those patent claims licensable by you that are necessarily infringed by your Contribution alone or by combination of your Contribution with the Project to which you submitted the Contribution. This license includes, at our option, the right to sublicense these same rights to third parties through multiple levels of sublicensees or other licensing or transfer arrangements.
+
+## 3. Property rights
+You represent that you have the legal authority to grant the above licenses. If your employer(s) has rights in the intellectual property you have created, which includes your Contribution, you represent that you have received permission to make Contributions on behalf of that employer or that your employer has waived those rights for your Contributions.
+You warrant that your Contribution is an original work of yours and that, to your knowledge, no other person claims or can claim any rights in the Contribution.
+You represent and warrant that, to the best of your knowledge, each Contribution does not infringe any copyright, trademark, patent, or other intellectual property right of any third party.
+
+In the event that you wish to submit a work of which you are not the author, you may submit it to IEM separately from a Contribution, providing full details of the source and any licenses or other restrictions (including but not limited to associated patents, trademarks and license agreements) of which you have personal knowledge and clearly marking the work as "Submitted on behalf of a third party".
+
+## 4. Warranties
+You are not expected to provide support for your Contributions, except to the extent you desire to provide support. Unless required by applicable law or agreed to in writing, and except for the warranties you give in this Agreement, the Contribution provided in this Projekt is provided without warranty of kind, including but not limited to any warranties or conditions of merchantability, or fitness for a particular purpose.
+
+## 5. Notice to IEM
+You agree to notify us in writing in the event that any of the circumstances warranted by you in this Agreement subsequently become invalid.
+
+
+## 6. Inclusion and Changing
+
+The Project is not obliged to accept or include every Contribution.
+IEM reserves the right to change the current license type to any other license type in future.
+
+## 7. Governing Law/ Jurisdiction
+The Agreement shall be governed by the law of the Federal Republic of Germany, without reference to its conflict of law provisions and excluding the provisions of the UN convention on the international sale of goods. The ordinary courts of Munich are hereby agreed as place of jurisdiction for all disputes arising from or connected with the Contract.
+
+**With your signature you confirm the above mentioned agreements.**

README.md

@@ -1 +1,68 @@
-# Software Product Health Assistant
+![SPHA Logo](docs/img/Software_Project_Health_Assistant_Secondary-Logo.png)
+
+## About
+
+SPHA is a fully automated tool suite that assesses and communicates all aspects
+of software product quality. It does so by combining data about your projects
+from sources like ticketing systems, and static analysis tools. For more details
+see [software-product.health](https://www.software-product.health).
+
+## SPHA-CLI Tool
+
+This project contains SPHA's command line tool, a wrapper around our
+[core library](https://www.github.com/fraunhofer-iem/spha). The CLI-tool can `transform` tool results
+into `RawValueKpis`, `calculate` a given `KpiHierarchy` based on `RawValueKpis`, and
+generate a human-readable report.  
+A tool demo using our [GitHub Action](https://www.github.com/fraunhofer-iem/spha-action) can be
+found [here](https://www.github.com/fraunhofer-iem/spha-demo).
+
+## Installation
+
+### Using Docker
+
+The easiest way to get started with SPHA is by using the included docker image. To
+build it locally run `docker build -t TAG_NAME .`. Afterward, you can run the container
+with `docker run TAG_NAME`. The default command will print the `--help` statement that
+further explains how to use SPHA.  
+This repository contains a prebuild version of SPHA's docker image. To use it just run
+`docker pull ghcr.io/fraunhofer-iem/spha-cli:latest` and then run `docker run fraunhofer-iem/spha-cli`.
+
+### Build native
+
+SPHA is a 100% Kotlin project build with Gradle. You must have Kotlin installed on your
+system. To use Gradle either install it locally our use the included Gradle wrapper.
+We aim to always support the latest version of Kotlin and Gradle.
+
+To build the project using the wrapper run `./gradlew build`.  
+`./gradlew run` executes SPHA. We use CLIKT as a command line framework, see their
+[documentation](https://ajalt.github.io/clikt/quickstart/#developing-command-line-applications-with-gradle) on how to
+interact with CLIKT based tools. By default, it will print the `--help` output that further explains
+how to use SPHA.
+
+## Usage
+
+After successfully building SPHA you can generally use one of the following three commands:
+* `transform` - transforms a given tool result into our internal `RawValueKpi` format
+* `calculate` - calculates a given `KpiHierarchy` by combining it with `RawValueKpi`
+* `report` - generates a human-readable report from a given `KpiResultHierarchy`
+
+For the most up-to-date documentation of each command run `--help`.
+
+## Contribute
+
+You are welcome to contribute to SPHA. Please make sure you adhere to our
+[contributing](CONTRIBUTING.md) guidelines.  
+First time contributors are asked to accept our
+[contributor license agreement (CLA)](CLA.md).
+For questions about the CLA please contact us at _SPHA(at)iem.fraunhofer.de_ or create an issue.
+
+## License
+
+Copyright (C) Fraunhofer IEM.  
+Software Product Health Assistant (SPHA) and all its components are published under the MIT license.
+
+<picture>
+<source media="(prefers-color-scheme: dark)" srcset="./docs/img/IEM_Logo_White.png">
+<img alt="Logo IEM" src="./docs/img/IEM_Logo_Dark.png">
+</picture>
+