Website for the REUSE Initiative https://reuse.website
Go to file
carmenbianca 1925ef27bc
continuous-integration/drone/push Build is passing Details
Merge pull request #57 from carmenbianca/campaign-by
Add a floating 'campaign by' text on the main page
2024-02-01 16:26:52 +01:00
.github/workflows build website completely in Github CI 2022-05-05 12:15:44 +02:00
.reuse clarify/fix license and copyright for logos 2022-09-30 15:30:10 +02:00
LICENSES Add CC-BY-SA-3.0 licence text 2024-02-01 16:24:28 +01:00
reuse-docs@1b277a5480 Revert to pre-3.1 version of `reuse-docs` 2023-06-21 17:20:50 +02:00
site Add 'campaign by' floating thingamajig to the main page 2024-02-01 16:23:26 +01:00
.drone.yml Sign `.drone.yml` 2023-01-17 14:48:27 +01:00
.gitignore improve gitignore to only consider non-docs and EN files 2022-05-05 10:59:26 +02:00
.gitmodules SPDX-Copyright -> SPDX-FileCopyrightText 2019-08-07 08:39:50 +02:00
Dockerfile Also pin to `alpine:3.16` in Dockerfile 2023-01-17 14:49:34 +01:00
LICENSE used website data from reuse-docs and improve deployment 2019-04-15 15:58:23 +02:00
README.md Fix wrong badge 2022-11-09 08:34:52 +01:00
check_translations.py add script to check which languages have complete translations for all index_ strings 2022-05-05 10:59:20 +02:00
docker-compose.dev.yml provide possibility to locally build website with all required steps 2022-05-05 10:57:26 +02:00
docker-compose.yml provide possibility to locally build website with all required steps 2022-05-05 10:57:26 +02:00
reuse.software.conf apply apache settings to both productive and localhost environments 2022-04-29 14:15:07 +02:00
sync-docs.sh move English files in separate subdirectory 2022-04-27 15:26:25 +02:00

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.