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 25b63dd5c5
Merge pull request #8 from fsfe/overhaul-2019
1 week ago
reuse-docs @ 23fb776e17 use latest 2.0 version of REUSE spec 2 weeks ago
site restructure index 1 week ago
.drone.yml slight adjustments for build process 2 weeks ago
.gitignore slight adjustments for build process 2 weeks ago
.gitmodules use reuse-docs as submodule 3 months ago
Dockerfile slight adjustments for build process 2 weeks ago
LICENSE used website data from reuse-docs and improve deployment 3 months ago
README.md Improve README instructions 2 weeks ago
docker-compose.yml slight adjustments for build process 2 weeks ago
sync-docs.sh Improve Dockerfile 2 weeks ago

README.md

REUSE

Build Status standard-readme compliant reuse compliant

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.

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 you may try running hugo in the site/ directory to generate the website when testing locally. 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! Just copy this badge into your readme:

[![reuse compliant](https://reuse.software/badge/reuse-compliant.svg)](https://reuse.software/)

Contribute

We’d love to get feedback on these practices, ideally in the form of pull requests which we can discuss around. To be able to contribute in this way, you need an account on git.fsfe.org, which you can get by going to our account creation page. This will sign you up for a volunteer account with the FSFE.

Once you’ve registered, your account needs to be activated. Just shoot a mail to contact@fsfe.org or directly to jonas@fsfe.org saying you’ve registered and would like to be activated. As soon as your account is activated, you can set a username and proceed to login to git.fsfe.org.

We also accept and appreciate feedback by creating issues in the project (requires the same account creation), or by sending e-mail to, again, contact@fsfe.org or jonas@fsfe.org.

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.