fsfe / reuse-docs

REUSE recommendations, tutorials, FAQ and specification
https://reuse.software
19 stars 20 forks source link

Tutorial: Mention tool commands that can help with the steps #50

Closed mxmehl closed 3 years ago

mxmehl commented 5 years ago

In the tutorial, we do not mention the new helpful commands the REUSE helper tool offers, e.g. download or addheader.

The question is whether we should base the tutorial on those commands. On the one hand, we could explain the usage of the tool directly in the tutorial. On the other hand, we would create a dependency on the tool, so users who cannot or don't want to use the tool would be left behind.

My suggestion: Let's mention the commands used for the individual steps in separate boxes after the respective parts. For example:

Goal: Explain mainly the manual method and basic rationale, but show how the tool supports these steps.

mxmehl commented 3 years ago

We already do that since quite some time