Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 3.06 KB

README.md

File metadata and controls

68 lines (49 loc) · 3.06 KB

REUSE website

Build Status standard-readme compliant REUSE status

We're working to make managing copyrights and licenses in free and open source software easier. This is the website for a guide of best practices, meant to demonstrate how to add copyright and license information to a project in ways which allow for more automation.

Most interesting files are located in site/content/en/, specifically:

  • site/content/en/spec-*.md --- Versions of the specifications.
  • site/content/en/faq.md --- Frequently asked questions.

Install

There's no installation here, but to test the website locally, run hugo server inside the site/ directory. Typically, we let our Drone CI build and deploy the website for us.

Usage

Go to https://reuse.software/ and enjoy :-) If your project follows the reuse guidelines, we encourage you to show that in your README.md and similar! You will find this and more developer tools here.

Contribute

We welcome your pull requests and issue reports. Please be aware that this repository does not contain the specification, tutorial, and FAQ, so please direct your inquiry to reuse docs.

Generally, we invite you to contact and join the REUSE mailing list.

Translation

The website "chrome" strings are localized using the standard, built-in Hugo i18n support. The Weblate project for these strings is REUSE Website Strings.

Translation happens by conversion Markdown into gettext using po4a. To generate the .md files from the gettext .po files, run: po4a po4a.conf. This also regenerates the .pot file, which is the gettext translation template, and syncs changes to the .po files. The Weblate project for these strings is REUSE Website Markdown.

License

The theme used for this website is based on github-project-landing-page which is licensed under the the MIT license.

The content of the website, the best practices, are licensed under Creative Commons Attribution-ShareAlike 4.0.

Please find the exact licenses and copyright holders in all file headers, accompanying .license files, and the DEP-5 file in .reuse/dep5.