diff --git a/docs/using-the-template/setup-license.md b/docs/using-the-template/setup-license.md index c47d1b0..7e78164 100644 --- a/docs/using-the-template/setup-license.md +++ b/docs/using-the-template/setup-license.md @@ -48,6 +48,19 @@ You do not have to annotate each single file, instead you can apply a license pe `pipx run reuse annotate -c "Deutsche Telekom AG" -l "CC-BY-4.0" --recursive --skip-existing ./img` +### Set up whole directories - alternative + +Alternatively you can declare the license for entire directories using glob patterns. +The license data is specified in `./RESUSE.toml`, the file should already exist in the template. + +Visit https://reuse.software/spec-3.2/#reusetoml to learn about the format. The existing file contains one commented-out example entry. + +:::warning + +Generally it is recommended to use the annotate --recursive option for better readability and clarity. +However in some scenarios it makes sense to declare a directory via .toml file, for example if external dependencies are included in your repository. + +::: ### Handle files with unkommon or binary formats diff --git a/docs/using-the-template/setup-reuse.md b/docs/using-the-template/setup-reuse.md index 9eac18a..aa096e6 100644 --- a/docs/using-the-template/setup-reuse.md +++ b/docs/using-the-template/setup-reuse.md @@ -13,8 +13,29 @@ All that remains to do is to set up the tool locally to specify license informat For simplicity it is recommended to run the tool with pipx, which, without any setup, runs python applications in isolated environments. Head over to https://pypa.github.io/pipx/installation/ for instructions. +## Test the REUSE command + +1. Run `pipx run reuse lint` +2. You should see output from REUSE. It may complain about non-compliance, that is ok at this point. + ## Initialize REUSE +:::tip + +This is no longer necessary (and the `init` subcommand no longer exists) as of the [reuse specification 3.2](https://reuse.software/spec-3.2/). + +You can skip ahead to the [next step](./setup-license.md)! + +::: + +:::tip + +As of spec version 3.2 `.reuse/dep5` has been replaced by `./REUSE.toml`. +You can update your old dep5 file to a .toml using `pipx run reuse convert-dep5` + +::: + + 1. Clone your repository locally 2. In the cloned directory, run `pipx run reuse init` 3. The command will ask basic information about the project