mirror of
https://github.com/mikaela/mikaela.github.io/
synced 2024-11-30 00:19:25 +01:00
1.9 KiB
1.9 KiB
REUSE notes
reuse is a tool for compliance with the REUSE recommendations.
says their GitHub
description and in practice this means having a license header in
all files or alternatively a file.license
file. The tool
can generate these, but I never remember the commands.
For more detailed explanation, consult reuse.software/tutorial
Adding headers
Copy-paste and add file name(s) to the end
# Autodetect how to add comment?
reuse addheader --copyright="Aminda Suomalainen <{{ page.email }}>" --license="CC0-1.0"
# Create a file.license
reuse addheader --copyright="Aminda Suomalainen <{{ page.email }}>" --license="CC0-1.0" --force-dot-license
# The usual # marks a comment
reuse addheader --copyright="Aminda Suomalainen <{{ page.email }}>" --license="CC0-1.0" --style python
- Note that
--year
can also be specified
Styles
c
means//
marks a commentpython
means#
marks a commenthtml
andcss
explain themselvestex
means%
marks a commentvim
means"
marks a comment- etc. when
style
is empty, supported ones are displayed, but I am unsure whether I need more and trying whatreuse
says works too.
Generic commands
reuse download --all
- downloads all licenses found toLICENSES/
reuse lint
- verifies compliancyreuse supported-licenses | less
- lists supported licenses identifiers
License identifiers I commonly use
CC0-1.0
CC-BY-4.0
CC-BY-ND-4.0
CC-BY-SA-4.0
BSD-3-Clause
Viewing source of this page reveals this one to be CC-BY-SA-4.0.