Website for the REUSE Initiative https://reuse.website
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Max Mehl daf8f0549a
Merge pull request #49 from fsfe/feature/pre-commit-revision
2 months ago
.github/workflows build website completely in Github CI 3 months ago
.reuse Merge branch 'master' into localizable 4 months ago
LICENSES update fontawesome 1 year ago
reuse-docs@f0d45b4da6 bump reuse-docs 2 months ago
site Explicit revision in pre-commit example 2 months ago
.drone.yml build docker image with buildkit 3 months ago
.gitignore improve gitignore to only consider non-docs and EN files 3 months ago
.gitmodules SPDX-Copyright -> SPDX-FileCopyrightText 3 years ago
Dockerfile install GNU diff to provide -I parameter for po4a 3 months ago
LICENSE used website data from reuse-docs and improve deployment 3 years ago
README.md make site localizable using po4a 2 years ago
check_translations.py add script to check which languages have complete translations for all index_ strings 3 months ago
docker-compose.dev.yml provide possibility to locally build website with all required steps 3 months ago
docker-compose.yml provide possibility to locally build website with all required steps 3 months ago
reuse.software.conf apply apache settings to both productive and localhost environments 4 months ago
sync-docs.sh move English files in separate subdirectory 4 months ago

README.md

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.

The specification, FAQ, and tutorial are located in a separate "docs" repository.

Install

Before doing anything, run the following commands to download the documentation as submodule, and to synchronise the contents of the submodule into the site/ directory:

git submodule update --init
bash sync-docs.sh

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. Those files are in data/.

Translation happens by conversion Markdown into gettext using po4a. To generate the .md files from the gettext .po files, run: po4a po/po4a.conf. This also regenerates the .pot file, which is the gettext translation template, and syncs changes to the .po files.

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.