Merge pull request #6 from hoijui/main

REUSE compliance and no spaces in file-names #5

.gitignore

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 Stefan Kerkmann <[email protected]>
+#
+# SPDX-License-Identifier: CC-BY-SA-4.0
+
 # For PCBs designed using KiCad: http://www.kicad-pcb.org/
 # Format documentation: http://kicad-pcb.org/help/file-formats/
 

.gitmodules

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 Stefan Kerkmann <[email protected]>
+#
+# SPDX-License-Identifier: CC-BY-SA-4.0
+
 [submodule "Firmware"]
 	path = Firmware
 	url = https://github.com/KarlK90/qmk_firmware

.reuse/dep5

@@ -0,0 +1,68 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: YAEMK
+Upstream-Contact: Stefan Kerkmann <[email protected]>
+Source: https://github.com/KarlK90/yaemk-split-kb
+
+Files:
+	PCB/YAEMK*
+	PCB/*-lib-table
+	PCB/lib/YAEMK.*
+Copyright: Stefan Kerkmann <[email protected]>
+License: GPL-3.0-only
+
+Files:
+	Bin/*.bin
+Copyright: qmk.fm
+License: GPL-2.0-or-later
+
+Files:
+	PCB/gerbers*
+	docs/yaemk_rev_1_2.html
+	docs/yaemk_*.pdf
+Copyright: Stefan Kerkmann <[email protected]>
+License: CC-BY-SA-4.0
+
+Files:
+	docs/images/*
+	Case/*
+	PCB/assembly/*.csv
+	PCB/assembly/overrides.json
+Copyright: Stefan Kerkmann <[email protected]>
+License: CC-BY-SA-4.0
+
+Files:
+	PCB/prettylib/Crystal_SMD_3225-4Pin_3.2x2.5mm.kicad_mod
+	PCB/prettylib/D_SOD-123.kicad_mod
+	PCB/prettylib/D_SOD-523.kicad_mod
+	PCB/prettylib/Fuse_1206_3216Metric.kicad_mod
+	PCB/prettylib/LED-0603.kicad_mod
+	PCB/prettylib/LQFP-48_7x7mm_P0.5mm.kicad_mod
+	PCB/prettylib/MountingHole_2.2mm_M2_Pad_Via.kicad_mod
+	PCB/prettylib/PinHeader_1x06_P2.54mm_Horizontal.kicad_mod
+	PCB/prettylib/RotaryEncoder_Alps_EC11E-Switch_Vertical_H20mm.kicad_mod
+	PCB/prettylib/SMD-0603.kicad_mod
+	PCB/prettylib/SMD-0805.kicad_mod
+	PCB/prettylib/SOLDER_JUMPER_2.kicad_mod
+	PCB/prettylib/SOLDER_JUMPER_3.kicad_mod
+	PCB/prettylib/SOT-23-5.kicad_mod
+	PCB/prettylib/SOT-23-6.kicad_mod
+	PCB/prettylib/SOT-23.kicad_mod
+	PCB/prettylib/TSSOP-8_4.4x3mm_P0.65mm.kicad_mod
+Copyright: Digi-Key Corporation <https://www.digikey.com/>
+License: CC-BY-SA-4.0
+# see: https://github.com/Digi-Key/digikey-kicad-library/blob/master/LICENSE.md
+
+Files:
+	PCB/prettylib/JLC_SMT_Assembly_Hole.kicad_mod
+	PCB/prettylib/LED-0603_flipable.kicad_mod
+	PCB/prettylib/LOGO.kicad_mod
+	PCB/prettylib/MX_KAILH_SOCKET_1U.kicad_mod
+	PCB/prettylib/MX_KAILH_SOCKET_2U_2X1U.kicad_mod
+	PCB/prettylib/SK6812_mini_e_flipable.kicad_mod
+	PCB/prettylib/SK6812_mini_flipable.kicad_mod
+	PCB/prettylib/SMD_Tacticle_Switch_TS24CA_flipable.kicad_mod
+	PCB/prettylib/SMD_Tacticle_Switch_TS24CA.kicad_mod
+	PCB/prettylib/SSD1107_DISPLAY.kicad_mod
+	PCB/prettylib/USB_C_Receptacle_MUP_U22401.kicad_mod
+Copyright: Stefan Kerkmann <[email protected]>
+License: CC-BY-SA-4.0

Bin/readme.md

@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2021 Stefan Kerkmann <[email protected]>
+
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
 # Test Firmware Files
 
 These firmware images are meant for easy testing purposes only when building your own YAEMK. Both images are VIA enabled, and meant to be used with oled screens and rgb leds.
@@ -14,4 +20,4 @@ These firmware images are meant for easy testing purposes only when building you
 
 * Hold the Reset+DFU button with the USB cable plugged in, detach cable and re-plug immediately release the button shortly after. Your keyboard shows up as `GDMicroelectronics GD32 DFU Bootloader`.
 * Flash firmware with dfu-util using this command:
-    * `dfu-util -d 28e9:0189 -s 0x08000000:leave -D yaemk_via_riscv.bin -w` 
+    * `dfu-util -d 28e9:0189 -s 0x08000000:leave -D yaemk_via_riscv.bin -w` 

LICENSES/MIT.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) <year> <copyright holders>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

PCB/assembly/kicad_pos_to_cpl.py

@@ -1,8 +1,11 @@
 #!/usr/bin/env python3
 # coding=utf8
 
+# SPDX-FileCopyrightText: 2019, Uri Shaked
+#
+# SPDX-License-Identifier: MIT
+
 # Converts a KiCad Footprint Position (.pos) File into JLCPCB compatible CPL file
-# Copyright (C) 2019, Uri Shaked. Released under the MIT license.
 # 
 # Usage: kicad_pos_to_cpl.py <input.csv> <output.csv> [overrides.json]
 #

docs/_config.yml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 Stefan Kerkmann <[email protected]>
+#
+# SPDX-License-Identifier: CC-BY-SA-4.0
+
 title: YAEMK
 description: YAEMK is yet another ergonomic mechanical (split-)keyboard
 theme: jekyll-theme-cayman 

docs/index.md

@@ -1,3 +1,9 @@
+<!--
+SPDX-FileCopyrightText: 2021 Stefan Kerkmann <[email protected]>
+
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
 ![YAEMK wide view](images/1_yaemk_wide.webp)
 ![YAEMK close up front](images/2_yaemk_close_up_rgb_front.webp)
 ![YAEMK close up back](images/4_yaemk_close_up_rgb_back.webp)

okh.toml

@@ -1,3 +1,7 @@
+# SPDX-FileCopyrightText: 2021 Stefan Kerkmann <[email protected]>
+#
+# SPDX-License-Identifier: CC-BY-SA-4.0
+
 okhv = "OKH-LOSHv1.0"
 name = "YAEMK - Yet Another Ergonomic Mechanical Keyboard"
 repo = "https://github.com/KarlK90/yaemk-split-kb"
@@ -15,4 +19,4 @@ function = "YEAMK is a 5x8 split keyboard with configurable thumb-clusters, rota
 bom = "PCB/assembly/YAEMK_bom.csv"
 manufacturing-instructions = "/docs/index.md"
 outer-dimension-dim = "mm"
-outer-dimension = "cube(size = [165,140,30])"
+outer-dimension = "cube(size = [165,140,30])"

readme.md

@@ -1,5 +1,15 @@
+<!--
+SPDX-FileCopyrightText: 2021 Stefan Kerkmann <[email protected]>
+
+SPDX-License-Identifier: CC-BY-SA-4.0
+-->
+
 # Yet Another Ergonomic Mechanical Keyboard
 
+[![REUSE status](
+    https://api.reuse.software/badge/github.com/KarlK90/yaemk-split-kb)](
+    https://api.reuse.software/info/github.com/KarlK90/yaemk-split-kb)
+
 ![YAEMK Front](docs/images/2_yaemk_close_up_rgb_front.webp)
 
 # [>>> VISIT THE WEBSITE <<<](https://karlk90.github.io/yaemk-split-kb/)