REUSE recommendations, tutorials, FAQ and specification https://reuse.software
Go to file
carmenbianca 0913b0a83b
Revert "Revert "Merge branch 'main' into stable""
This reverts commit 1b277a5480.
2023-06-21 17:40:16 +02:00
.reuse make reuse compliant 2020-10-16 17:38:13 +02:00
LICENSES Remove unused license 2019-07-05 12:01:02 +02:00
po Revert "Revert "Merge branch 'main' into stable"" 2023-06-21 17:40:16 +02:00
.gitignore make reuse compliant 2020-10-16 17:38:13 +02:00
CHANGELOG.md Revert "Revert "Merge branch 'main' into stable"" 2023-06-21 17:40:16 +02:00
README.md chore: improve README, branch name, badge, formatting 2023-03-06 15:43:07 +01:00
faq.md Revert "Revert "Merge branch 'main' into stable"" 2023-06-21 17:40:16 +02:00
spec.md Revert "Revert "Merge branch 'main' into stable"" 2023-06-21 17:40:16 +02:00
tutorial.md make REUSE helper tool ignore blocks with false-positive licensing/copyright information 2023-03-06 15:56:05 +01:00

README.md

REUSE documents

standard-readme compliant REUSE status

We're working to make managing copyrights and licenses in free and open source software easier. This is a collection of tutorials, FAQs and specifications to demonstrate how to add copyright and license information to a project in ways which allow for more automation.

Install

There's no installation here, only the plain text documents. The sister repository reuse-website includes this repository as a submodule to display it on reuse.software.

Usage

Go to reuse.software and enjoy :-) If your project follows the reuse guidelines, we encourage you to show that in your README.md and similar! Just register your project with the REUSE API and copy the resulting badge code in your README file.

Contribute

We'd love to get feedback on these practices, ideally in the form of pull requests which we can discuss around.

We also accept and appreciate feedback by creating issues in the project or by sending an e-mail to the public REUSE mailing list.

Translation

Translation happens by conversion Markdown into gettext using po4a. To generate the .md files from the gettext .po files, run: po4a po/po4a.conf.

Branches

The latest official specification release is in the stable branch, while the main branch contains fixes and new and potentially breaking specification changes. Typically, non-spec changes or insignificant fixes for the spec are "backported" to the stable branch.

License

The relevant documents in this repository are licensed under Creative Commons Attribution-ShareAlike 4.0.