SPDX lizensierung mit dem REUSE tool #92

Closed
opened 2023-01-18 13:43:03 +01:00 by hoijui · 5 comments
Contributor

Hab hier alle befehle zusammen ide das repo im aktuellen zustand in richtig-stellen wuerden. Fehlt nur noch bei Thies 3 mal den Nachnahmen hinzufuegen und seine echte email einzufuegen.
sollte so auhc unter Mac funktionieren, wenn ihr dies im terminal in dem verzeichnis des projekts ausfuehrt. schaut zuerst dass alle eure aenderungen vorher committed sind.
Bei fragne gerne hier oder ueber Jo (falls ich hier nicht antworte weil ich keine benachrichtigung kriege).

#!/bin/sh
# SPDX-FileCopyrightText: 2023 Robin Vobruba <hoijui.quaero@gmail.com>
#
# SPDX-License-Identifier: Unlicense

# Authors of this project:
# * Lukas Hopp <lukas.hopp@posteo.de>
# * Felix Schimmeyer <felixschimmeyer@web.de>
# * Thies <thies@noreply.code.curious.bio>    

mkdir -p .reuse
echo "Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: Akustikabsorber aus Pilzmyzelkompositmaterial
Upstream-Contact: Felix Schimmeyer <felixschimmeyer@web.de>
Source: https://code.curious.bio/felix/myzel-akustikabsorber/

Files: *.pdf *.stl *.jpg *.scad *.fcstd *.FCStd *.webp *.svg bom.csv *.lib *.xml
Copyright: Curious Community Labs e. V. <hallo.welt@curious.bio>
License: CERN-OHL-S-2.0

Files: **/bom.csv
Copyright: Curious Community Labs e. V. <hallo.welt@curious.bio>
License: CC-BY-SA-4.0
" > .reuse/dep5

# SPDX/REUSE Header bei einer einzelnen Datei hinzufuegen
reuse addheader \
	--copyright="Curious Community Labs e. V. <hallo.welt@curious.bio>" \
	--license="CC0-1.0" \
	.gitignore

# Removes first 3 lines of okh.toml (old license info)
sed -i -e 1,3d okh.toml

# SPDX/REUSE Header bei allen Markdown Dateien und okh.toml hinzufuegen
reuse addheader \
	--copyright="Curious Community Labs e. V. <hallo.welt@curious.bio>" \
	--license="CC-BY-SA-4.0" \
	**.md \
	**/okh.toml

# Template Dateien loeschen
rm \
	build/assembly.vf_recipe.ttl \
	build/doc/assembly/vf_recipe.ttl \
	build/manuf.vf_recipe.ttl \
	build/recycle.vf_recipe.ttl \
	build/res/assets/media/img/animation-1.gif \
	build/res/assets/media/img/drawing-1.png \
	"build/res/assets/media/img/photo_2021-11-09 14.35.25.jpeg" \
	build/res/assets/media/vid/tutorial.webm \
	build/src/firmware/Makefile \
	build/src/sim/stress-test.OpenFOAM

# Downloads all REUSE license files to the LICENSES folder.
# This has to be the last command.
reuse download --all
Hab hier alle befehle zusammen ide das repo im aktuellen zustand in richtig-stellen wuerden. Fehlt nur noch bei Thies 3 mal den Nachnahmen hinzufuegen und seine echte email einzufuegen. sollte so auhc unter Mac funktionieren, wenn ihr dies im terminal in dem verzeichnis des projekts ausfuehrt. schaut zuerst dass alle eure aenderungen vorher committed sind. Bei fragne gerne hier oder ueber Jo (falls ich hier nicht antworte weil ich keine benachrichtigung kriege). ``` #!/bin/sh # SPDX-FileCopyrightText: 2023 Robin Vobruba <hoijui.quaero@gmail.com> # # SPDX-License-Identifier: Unlicense # Authors of this project: # * Lukas Hopp <lukas.hopp@posteo.de> # * Felix Schimmeyer <felixschimmeyer@web.de> # * Thies <thies@noreply.code.curious.bio> mkdir -p .reuse echo "Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ Upstream-Name: Akustikabsorber aus Pilzmyzelkompositmaterial Upstream-Contact: Felix Schimmeyer <felixschimmeyer@web.de> Source: https://code.curious.bio/felix/myzel-akustikabsorber/ Files: *.pdf *.stl *.jpg *.scad *.fcstd *.FCStd *.webp *.svg bom.csv *.lib *.xml Copyright: Curious Community Labs e. V. <hallo.welt@curious.bio> License: CERN-OHL-S-2.0 Files: **/bom.csv Copyright: Curious Community Labs e. V. <hallo.welt@curious.bio> License: CC-BY-SA-4.0 " > .reuse/dep5 # SPDX/REUSE Header bei einer einzelnen Datei hinzufuegen reuse addheader \ --copyright="Curious Community Labs e. V. <hallo.welt@curious.bio>" \ --license="CC0-1.0" \ .gitignore # Removes first 3 lines of okh.toml (old license info) sed -i -e 1,3d okh.toml # SPDX/REUSE Header bei allen Markdown Dateien und okh.toml hinzufuegen reuse addheader \ --copyright="Curious Community Labs e. V. <hallo.welt@curious.bio>" \ --license="CC-BY-SA-4.0" \ **.md \ **/okh.toml # Template Dateien loeschen rm \ build/assembly.vf_recipe.ttl \ build/doc/assembly/vf_recipe.ttl \ build/manuf.vf_recipe.ttl \ build/recycle.vf_recipe.ttl \ build/res/assets/media/img/animation-1.gif \ build/res/assets/media/img/drawing-1.png \ "build/res/assets/media/img/photo_2021-11-09 14.35.25.jpeg" \ build/res/assets/media/vid/tutorial.webm \ build/src/firmware/Makefile \ build/src/sim/stress-test.OpenFOAM # Downloads all REUSE license files to the LICENSES folder. # This has to be the last command. reuse download --all ```
Owner

Der Reuse header in allen Dateien ist nicht mehr nötig, wenn bereits eine .reuse/dep5 Datei die Lizenzbestimmungen regelt. Mann sollte sich daher für einen Weg entscheiden.

Ich persönlikch bevorzuge die .reuse/dep5 methode, da das bei einer entsprechenden Ordnerstruktur weniger Plege der einzelnen Dateien bedarf.

Der Reuse header in allen Dateien ist nicht mehr nötig, wenn bereits eine `.reuse/dep5` Datei die Lizenzbestimmungen regelt. Mann sollte sich daher für einen Weg entscheiden. Ich persönlikch bevorzuge die `.reuse/dep5` methode, da das bei einer entsprechenden Ordnerstruktur weniger Plege der einzelnen Dateien bedarf.
Owner

Das Copyright bitte auf Curious Community Labs e. V. austellen.

Das Copyright bitte auf `Curious Community Labs e. V.` austellen.
Owner

Die Verwendung der SPDX Header für reuse sollte bei Markdown nicht wie in:

https://code.curious.bio/curious.bio/myzel-akustikabsorber/raw/branch/main/mod/mould/README.md

als Headline

# SPDX-FileCopyrightText: 2023 Curious Community Labs e. V.
# SPDX-License-Identifier: CC-BY-4.0

sondern als Kommentar:

<!--
SPDX-License-Identifier: CC-BY-SA-4.0
-->

einfließen.

Die Verwendung der SPDX Header für reuse sollte bei Markdown nicht wie in: https://code.curious.bio/curious.bio/myzel-akustikabsorber/raw/branch/main/mod/mould/README.md als Headline ```txt # SPDX-FileCopyrightText: 2023 Curious Community Labs e. V. # SPDX-License-Identifier: CC-BY-4.0 ``` sondern als Kommentar: ```txt <!-- SPDX-License-Identifier: CC-BY-SA-4.0 --> ``` einfließen.
Author
Contributor

Der Reuse header in allen Dateien ist nicht mehr nötig, wenn bereits eine .reuse/dep5 Datei die Lizenzbestimmungen regelt. Mann sollte sich daher für einen Weg entscheiden.

Ich persönlikch bevorzuge die .reuse/dep5 methode, da das bei einer entsprechenden Ordnerstruktur weniger Plege der einzelnen Dateien bedarf.

Das sehe ich anderst.
Ich wuerde die infos wenn immer moeglich in die sourcen als comment einfuegen. und wenn nicht moeglich (weils keine text-basierten dateine sind, oder es ein format ist welches keine Kommentare unterstuetzt), muss man entscheiden ob man die infos durch ne separate *.license datei zu jeder einzelnen solchen datei hinzufuegt, oder ob man den .resue/deb5 anstatz verwendet. Wenn das mehr als ne handvoll dateien betrifft, wuerd ich dir da zustimmen, und das mit .reuse/deb5 abhandeln, aber dann nur fuer diese dateien, nicht die sources wo kommentare moeglich sind.

Der Grund ist, dass die Datein so, wenn sie rumkopiert werden, die noetigen infos gleich mit dabei haben, un ddass man sie, wenn sie isch anedern, auch direkt in der datei aendern kann (fuer nen zusaetlichen author z.B. praktisch).

Schlussendlich hat die FSF, die das REUSE tool entwickelt, und die community durm herum, sich ja auch was dabei gedacht, das mit den kommentaren in den vordergrund zu stellen, das mit den .license dateien als alternative moeglichkeit, wenn ersteres nicht ghet, und das mit .reuse/deb5 ist nur schwer irgendwo bei denne zu finden.

> Der Reuse header in allen Dateien ist nicht mehr nötig, wenn bereits eine `.reuse/dep5` Datei die Lizenzbestimmungen regelt. Mann sollte sich daher für einen Weg entscheiden. > > Ich persönlikch bevorzuge die `.reuse/dep5` methode, da das bei einer entsprechenden Ordnerstruktur weniger Plege der einzelnen Dateien bedarf. Das sehe ich anderst. Ich wuerde die infos wenn immer moeglich in die sourcen als comment einfuegen. und wenn nicht moeglich (weils keine text-basierten dateine sind, oder es ein format ist welches keine Kommentare unterstuetzt), muss man entscheiden ob man die infos durch ne separate `*.license` datei zu jeder einzelnen solchen datei hinzufuegt, oder ob man den .resue/deb5 anstatz verwendet. Wenn das mehr als ne handvoll dateien betrifft, wuerd ich dir da zustimmen, und das mit .reuse/deb5 abhandeln, aber dann nur fuer diese dateien, nicht die sources wo kommentare moeglich sind. Der Grund ist, dass die Datein so, wenn sie rumkopiert werden, die noetigen infos gleich mit dabei haben, un ddass man sie, wenn sie isch anedern, auch direkt in der datei aendern kann (fuer nen zusaetlichen author z.B. praktisch). Schlussendlich hat die FSF, die das REUSE tool entwickelt, und die community durm herum, sich ja auch was dabei gedacht, das mit den kommentaren in den vordergrund zu stellen, das mit den .license dateien als alternative moeglichkeit, wenn ersteres nicht ghet, und das mit .reuse/deb5 ist nur schwer irgendwo bei denne zu finden.
Author
Contributor

Hab das script angepasst (bzgl. copyright).

Hab das script angepasst (bzgl. copyright).
thies closed this issue 2023-03-29 17:49:28 +02:00
Sign in to join this conversation.
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: curious.bio/myzel-akustikabsorber#92
No description provided.