feat: Added usage help to the README

Also changed the wording for clarity.

Signed-off-by: ElBe <elbe@noreply.localhost>
This commit is contained in:
ElBe 2026-06-11 23:45:36 +00:00
parent a71fdd8ce1
commit ad61aab4d6

View File

@ -5,7 +5,7 @@ The MITCR is a modified variant of the MIT License designed to preserve the free
## Overview ## Overview
This document provides a non-binding summary of the rights and restrictions under the MITCR license. This document provides a non-binding summary of the rights and restrictions under the MITCR license.
Only the terms contained in the [license file](https://git.elbe-dev.com/ElBe-Development/MITCR/src/branch/main/LICENSE.txt) are legally binding. Only the terms contained in the [license file](https://git.elbe-dev.com/ElBe-Development/MITCR/src/branch/main/LICENSE.txt) are binding.
## What You *May* Do ## What You *May* Do
@ -20,6 +20,22 @@ Only the terms contained in the [license file](https://git.elbe-dev.com/ElBe-Dev
* Incorporate the Software into any commercial product, service, or workflow without written authorization. * Incorporate the Software into any commercial product, service, or workflow without written authorization.
* Remove or alter copyright notices, attribution statements, or license terms in distributed copies. * Remove or alter copyright notices, attribution statements, or license terms in distributed copies.
## Usage
If you want to use the MITCR license in your own projects, you can copy the [license file](https://git.elbe-dev.com/ElBe-Development/MITCR/src/branch/main/LICENSE.txt) into the root folder of your project.
### Top-notice
In many cases it may be beneficial to add a notice at the top of your source files, that links back to your original license file.
It could be done in a format like this (for e.g. Java):
```java
/*
* Copyright (c) [year]-present [name]
* This software is licensed under the MITCR license. The full text for the license will be bundled with this software or can be found at https://git.elbe-dev.com/ElBe-Development/MITCR.
*/
```
## Important Notes ## Important Notes
This summary is not legal advice. If you have questions about permitted use, commercial licensing, or interpretation of the license, please contact the license's author: This summary is not legal advice. If you have questions about permitted use, commercial licensing, or interpretation of the license, please contact the license's author: