Преглед на файлове

add license header to source files

Thomas Buck преди 3 месеца
родител
ревизия
f700e1c4c5
променени са 9 файла, в които са добавени 185 реда и са изтрити 3 реда
  1. 26
    0
      .github/workflows/docs.yml
  2. 26
    0
      .github/workflows/kicad.yml
  3. 1
    1
      README.md
  4. 2
    2
      docs/README.md
  5. 26
    0
      docs/book.toml
  6. 26
    0
      docs/generate_docs.sh
  7. 26
    0
      hardware/fetch_jlc.sh
  8. 26
    0
      hardware/generate_fab.sh
  9. 26
    0
      hardware/generate_plot.sh

+ 26
- 0
.github/workflows/docs.yml Целия файл

1
+# SPDX-FileCopyrightText: 2023 - 2024 Thomas Buck <thomas@xythobuz.de>
2
+# SPDX-License-Identifier: CERN-OHL-S-2.0+
3
+#
4
+#  ------------------------------------------------------------------------------
5
+# | Copyright (c) 2023 - 2024 Thomas Buck <thomas@xythobuz.de>                   |
6
+# |                                                                              |
7
+# | This source describes Open Hardware and is licensed under the CERN-OHL-S v2  |
8
+# | or any later version.                                                        |
9
+# |                                                                              |
10
+# | You may redistribute and modify this source and make products using it under |
11
+# | the terms of the CERN-OHL-S v2 (https://ohwr.org/cern_ohl_s_v2.txt)          |
12
+# | or any later version.                                                        |
13
+# |                                                                              |
14
+# | This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY,          |
15
+# | INCLUDING OF MERCHANTABILITY, SATISFACTORY QUALITY AND FITNESS FOR A         |
16
+# | PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 (or any later version)      |
17
+# | for applicable conditions.                                                   |
18
+# |                                                                              |
19
+# | Source location: https://github.com/drinkrobotics/dispensy                   |
20
+# |                                                                              |
21
+# | As per CERN-OHL-S v2 section 4, should You produce hardware based on this    |
22
+# | source, You must where practicable maintain the Source Location visible      |
23
+# | on the external case of the Gizmo or other products you make using this      |
24
+# | source.                                                                      |
25
+#  ------------------------------------------------------------------------------
26
+
1
 name: Docs
27
 name: Docs
2
 
28
 
3
 # only build single instance of docs for latest main branch
29
 # only build single instance of docs for latest main branch

+ 26
- 0
.github/workflows/kicad.yml Целия файл

1
+# SPDX-FileCopyrightText: 2023 - 2024 Thomas Buck <thomas@xythobuz.de>
2
+# SPDX-License-Identifier: CERN-OHL-S-2.0+
3
+#
4
+#  ------------------------------------------------------------------------------
5
+# | Copyright (c) 2023 - 2024 Thomas Buck <thomas@xythobuz.de>                   |
6
+# |                                                                              |
7
+# | This source describes Open Hardware and is licensed under the CERN-OHL-S v2  |
8
+# | or any later version.                                                        |
9
+# |                                                                              |
10
+# | You may redistribute and modify this source and make products using it under |
11
+# | the terms of the CERN-OHL-S v2 (https://ohwr.org/cern_ohl_s_v2.txt)          |
12
+# | or any later version.                                                        |
13
+# |                                                                              |
14
+# | This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY,          |
15
+# | INCLUDING OF MERCHANTABILITY, SATISFACTORY QUALITY AND FITNESS FOR A         |
16
+# | PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 (or any later version)      |
17
+# | for applicable conditions.                                                   |
18
+# |                                                                              |
19
+# | Source location: https://github.com/drinkrobotics/dispensy                   |
20
+# |                                                                              |
21
+# | As per CERN-OHL-S v2 section 4, should You produce hardware based on this    |
22
+# | source, You must where practicable maintain the Source Location visible      |
23
+# | on the external case of the Gizmo or other products you make using this      |
24
+# | source.                                                                      |
25
+#  ------------------------------------------------------------------------------
26
+
1
 name: PCB
27
 name: PCB
2
 
28
 
3
 # build for each push and pull request
29
 # build for each push and pull request

+ 1
- 1
README.md Целия файл

12
 This project is licensed under the [CERN Open Hardware Licence Version 2 - Strongly Reciprocal (CERN-OHL-S-2.0+)](https://ohwr.org/cern_ohl_s_v2.txt) or any later version.
12
 This project is licensed under the [CERN Open Hardware Licence Version 2 - Strongly Reciprocal (CERN-OHL-S-2.0+)](https://ohwr.org/cern_ohl_s_v2.txt) or any later version.
13
 
13
 
14
 The docs are built using [mdbook](https://github.com/rust-lang/mdBook), licensed as `MPL-2.0`.
14
 The docs are built using [mdbook](https://github.com/rust-lang/mdBook), licensed as `MPL-2.0`.
15
-The PCB SVG files in the documentation are displayed using [svg-pan-zoom](https://github.com/bumbu/svg-pan-zoom), licensed as BSD-2-Clause.
15
+The PCB SVG files in the documentation are displayed using [svg-pan-zoom](https://github.com/bumbu/svg-pan-zoom), licensed as `BSD-2-Clause`.
16
 
16
 
17
 Please also take a look at the `README.md` files in the subfolders of this project for more info.
17
 Please also take a look at the `README.md` files in the subfolders of this project for more info.
18
 
18
 

+ 2
- 2
docs/README.md Целия файл

5
 
5
 
6
 ## Dependencies
6
 ## Dependencies
7
 
7
 
8
-The PCB SVG files are displayed using [svg-pan-zoom](https://github.com/bumbu/svg-pan-zoom), licensed as BSD-2-Clause.
8
+The PCB SVG files are displayed using [svg-pan-zoom](https://github.com/bumbu/svg-pan-zoom), licensed as `BSD-2-Clause`.
9
 Fetch the included git submodules after cloning this repository before working on the docs.
9
 Fetch the included git submodules after cloning this repository before working on the docs.
10
 
10
 
11
     git submodule update --init
11
     git submodule update --init
12
 
12
 
13
 ## Local Build
13
 ## Local Build
14
 
14
 
15
-The docs are built using [mdbook](https://github.com/rust-lang/mdBook).
15
+The docs are built using [mdbook](https://github.com/rust-lang/mdBook), licensed as `MPL-2.0`.
16
 Get the [latest release from GitHub](https://github.com/rust-lang/mdBook/releases) for a pre-built binary if you want to test changes to the docs locally.
16
 Get the [latest release from GitHub](https://github.com/rust-lang/mdBook/releases) for a pre-built binary if you want to test changes to the docs locally.
17
 
17
 
18
     mdbook serve --open docs
18
     mdbook serve --open docs

+ 26
- 0
docs/book.toml Целия файл

1
+# SPDX-FileCopyrightText: 2023 - 2024 Thomas Buck <thomas@xythobuz.de>
2
+# SPDX-License-Identifier: CERN-OHL-S-2.0+
3
+#
4
+#  ------------------------------------------------------------------------------
5
+# | Copyright (c) 2023 - 2024 Thomas Buck <thomas@xythobuz.de>                   |
6
+# |                                                                              |
7
+# | This source describes Open Hardware and is licensed under the CERN-OHL-S v2  |
8
+# | or any later version.                                                        |
9
+# |                                                                              |
10
+# | You may redistribute and modify this source and make products using it under |
11
+# | the terms of the CERN-OHL-S v2 (https://ohwr.org/cern_ohl_s_v2.txt)          |
12
+# | or any later version.                                                        |
13
+# |                                                                              |
14
+# | This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY,          |
15
+# | INCLUDING OF MERCHANTABILITY, SATISFACTORY QUALITY AND FITNESS FOR A         |
16
+# | PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 (or any later version)      |
17
+# | for applicable conditions.                                                   |
18
+# |                                                                              |
19
+# | Source location: https://github.com/drinkrobotics/dispensy                   |
20
+# |                                                                              |
21
+# | As per CERN-OHL-S v2 section 4, should You produce hardware based on this    |
22
+# | source, You must where practicable maintain the Source Location visible      |
23
+# | on the external case of the Gizmo or other products you make using this      |
24
+# | source.                                                                      |
25
+#  ------------------------------------------------------------------------------
26
+
1
 [book]
27
 [book]
2
 title = "Dispensy"
28
 title = "Dispensy"
3
 authors = ["xythobuz"]
29
 authors = ["xythobuz"]

+ 26
- 0
docs/generate_docs.sh Целия файл

1
 #!/bin/bash
1
 #!/bin/bash
2
 
2
 
3
+# SPDX-FileCopyrightText: 2023 - 2024 Thomas Buck <thomas@xythobuz.de>
4
+# SPDX-License-Identifier: CERN-OHL-S-2.0+
5
+#
6
+#  ------------------------------------------------------------------------------
7
+# | Copyright (c) 2023 - 2024 Thomas Buck <thomas@xythobuz.de>                   |
8
+# |                                                                              |
9
+# | This source describes Open Hardware and is licensed under the CERN-OHL-S v2  |
10
+# | or any later version.                                                        |
11
+# |                                                                              |
12
+# | You may redistribute and modify this source and make products using it under |
13
+# | the terms of the CERN-OHL-S v2 (https://ohwr.org/cern_ohl_s_v2.txt)          |
14
+# | or any later version.                                                        |
15
+# |                                                                              |
16
+# | This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY,          |
17
+# | INCLUDING OF MERCHANTABILITY, SATISFACTORY QUALITY AND FITNESS FOR A         |
18
+# | PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 (or any later version)      |
19
+# | for applicable conditions.                                                   |
20
+# |                                                                              |
21
+# | Source location: https://github.com/drinkrobotics/dispensy                   |
22
+# |                                                                              |
23
+# | As per CERN-OHL-S v2 section 4, should You produce hardware based on this    |
24
+# | source, You must where practicable maintain the Source Location visible      |
25
+# | on the external case of the Gizmo or other products you make using this      |
26
+# | source.                                                                      |
27
+#  ------------------------------------------------------------------------------
28
+
3
 cd "$(dirname "$0")"
29
 cd "$(dirname "$0")"
4
 
30
 
5
 echo "Generating plots"
31
 echo "Generating plots"

+ 26
- 0
hardware/fetch_jlc.sh Целия файл

1
 #!/bin/bash
1
 #!/bin/bash
2
 
2
 
3
+# SPDX-FileCopyrightText: 2023 - 2024 Thomas Buck <thomas@xythobuz.de>
4
+# SPDX-License-Identifier: CERN-OHL-S-2.0+
5
+#
6
+#  ------------------------------------------------------------------------------
7
+# | Copyright (c) 2023 - 2024 Thomas Buck <thomas@xythobuz.de>                   |
8
+# |                                                                              |
9
+# | This source describes Open Hardware and is licensed under the CERN-OHL-S v2  |
10
+# | or any later version.                                                        |
11
+# |                                                                              |
12
+# | You may redistribute and modify this source and make products using it under |
13
+# | the terms of the CERN-OHL-S v2 (https://ohwr.org/cern_ohl_s_v2.txt)          |
14
+# | or any later version.                                                        |
15
+# |                                                                              |
16
+# | This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY,          |
17
+# | INCLUDING OF MERCHANTABILITY, SATISFACTORY QUALITY AND FITNESS FOR A         |
18
+# | PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 (or any later version)      |
19
+# | for applicable conditions.                                                   |
20
+# |                                                                              |
21
+# | Source location: https://github.com/drinkrobotics/dispensy                   |
22
+# |                                                                              |
23
+# | As per CERN-OHL-S v2 section 4, should You produce hardware based on this    |
24
+# | source, You must where practicable maintain the Source Location visible      |
25
+# | on the external case of the Gizmo or other products you make using this      |
26
+# | source.                                                                      |
27
+#  ------------------------------------------------------------------------------
28
+
3
 # https://github.com/TousstNicolas/JLC2KiCad_lib
29
 # https://github.com/TousstNicolas/JLC2KiCad_lib
4
 
30
 
5
 # enter directory of script
31
 # enter directory of script

+ 26
- 0
hardware/generate_fab.sh Целия файл

1
 #!/bin/bash
1
 #!/bin/bash
2
 
2
 
3
+# SPDX-FileCopyrightText: 2023 - 2024 Thomas Buck <thomas@xythobuz.de>
4
+# SPDX-License-Identifier: CERN-OHL-S-2.0+
5
+#
6
+#  ------------------------------------------------------------------------------
7
+# | Copyright (c) 2023 - 2024 Thomas Buck <thomas@xythobuz.de>                   |
8
+# |                                                                              |
9
+# | This source describes Open Hardware and is licensed under the CERN-OHL-S v2  |
10
+# | or any later version.                                                        |
11
+# |                                                                              |
12
+# | You may redistribute and modify this source and make products using it under |
13
+# | the terms of the CERN-OHL-S v2 (https://ohwr.org/cern_ohl_s_v2.txt)          |
14
+# | or any later version.                                                        |
15
+# |                                                                              |
16
+# | This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY,          |
17
+# | INCLUDING OF MERCHANTABILITY, SATISFACTORY QUALITY AND FITNESS FOR A         |
18
+# | PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 (or any later version)      |
19
+# | for applicable conditions.                                                   |
20
+# |                                                                              |
21
+# | Source location: https://github.com/drinkrobotics/dispensy                   |
22
+# |                                                                              |
23
+# | As per CERN-OHL-S v2 section 4, should You produce hardware based on this    |
24
+# | source, You must where practicable maintain the Source Location visible      |
25
+# | on the external case of the Gizmo or other products you make using this      |
26
+# | source.                                                                      |
27
+#  ------------------------------------------------------------------------------
28
+
3
 cd "$(dirname "$0")"
29
 cd "$(dirname "$0")"
4
 
30
 
5
 INFILE="dispensy.kicad_pcb"
31
 INFILE="dispensy.kicad_pcb"

+ 26
- 0
hardware/generate_plot.sh Целия файл

1
 #!/bin/bash
1
 #!/bin/bash
2
 
2
 
3
+# SPDX-FileCopyrightText: 2023 - 2024 Thomas Buck <thomas@xythobuz.de>
4
+# SPDX-License-Identifier: CERN-OHL-S-2.0+
5
+#
6
+#  ------------------------------------------------------------------------------
7
+# | Copyright (c) 2023 - 2024 Thomas Buck <thomas@xythobuz.de>                   |
8
+# |                                                                              |
9
+# | This source describes Open Hardware and is licensed under the CERN-OHL-S v2  |
10
+# | or any later version.                                                        |
11
+# |                                                                              |
12
+# | You may redistribute and modify this source and make products using it under |
13
+# | the terms of the CERN-OHL-S v2 (https://ohwr.org/cern_ohl_s_v2.txt)          |
14
+# | or any later version.                                                        |
15
+# |                                                                              |
16
+# | This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY,          |
17
+# | INCLUDING OF MERCHANTABILITY, SATISFACTORY QUALITY AND FITNESS FOR A         |
18
+# | PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 (or any later version)      |
19
+# | for applicable conditions.                                                   |
20
+# |                                                                              |
21
+# | Source location: https://github.com/drinkrobotics/dispensy                   |
22
+# |                                                                              |
23
+# | As per CERN-OHL-S v2 section 4, should You produce hardware based on this    |
24
+# | source, You must where practicable maintain the Source Location visible      |
25
+# | on the external case of the Gizmo or other products you make using this      |
26
+# | source.                                                                      |
27
+#  ------------------------------------------------------------------------------
28
+
3
 cd "$(dirname "$0")"
29
 cd "$(dirname "$0")"
4
 
30
 
5
 OUTDIR="plot"
31
 OUTDIR="plot"

Loading…
Отказ
Запис