forked from iop-alliance/okh-search
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathokh-YourHardwareName.yml
170 lines (122 loc) · 8.07 KB
/
okh-YourHardwareName.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# Open know-how manifest
# according to The Open Know-How Manifest Specification Version 1.0
# for more info, see http://openknowhow.org/
# The content of this manifest file is licensed under a Creative Commons Attribution 4.0 International License.
# Licenses for modification and distribution of the hardware, documentation, source-code, etc are stated separately.
# Remove any fields that are not used. Comments (beginning with '#') may also be removed.
# Manifest metadata
date-created: 2019-11-16 # YYYY-MM-DD
#date-updated: [value] # YYYY-MM-DD
manifest-author:
name: Andre Maia Chagas # required | text
affiliation: University of Sussex # text
email: [email protected] # email address
manifest-language: EN-UK
#documentation-language: [language-code]-[region]
#manifest-is-translation:
# title: [value] # text | Title of the original
# manifest: [value] # URL - Absolute path | OKH manifest location
# web: [value] # URL - Absolute path | web presence location
# lang: [language]-[region] # language of original
#documentation-is-translation:
# title: [value] # text | Title of the original
# manifest: [value] # URL - Absolute path | OKH manifest location
# web: [value] # URL - Absolute path | web presence location
# lang: [language]-[region] # language of original
# Properties
title: [value] # required | text | A title to identify the thing
description: | # required | paragraph
[value]
#intended-use: | # recommended | Paragraph
# [value]
keywords: # At least one keyword is recommended | text array
- [keyword 1]
- [keyword 2]
project-link: [value] # At least project-link or documentation-home is required, otherwise recommended | absolute path URL
#health-safety-notice: | # paragraph
# [value]
#contact:
# name: [value] # text
# affiliation: [value] # text
# email: [value] # email address
# social:
# - platform: [value] # text
# user-handle: [value] # text
contributors: # recommended
- name: [contributor 1] # text
# affiliation: [value] # text
# email: [value] # email address
#image: [value] # recommended | absolute or relative path
#version: [value] # text
#development-stage: [value] # text
#made: [true/false] # boolean - true or false
#made-independently: [true/false] # boolean - true or false
#standards-used:
# - standard-title: [value] # Required where used | Title of the standard used in developing the design or documentation
# publisher: [value] # Publisher of the standard
# reference: [value] # Reference indentifier of the standard (e.g. ISO 9001)
# certification: # If certification has been granted confirming compliance with the standard
# - certifier: [value] # Individual or organisation granting the certification. Use "Self" for self-certification
# date-awarded: [value] # Date certification was granted
# link: [value] # Link to evidence of certification (e.g. certificate). Use an an absolute path to an external resource or an absolute or relative path to evidence within the documentation.
#derivative-of:
# title: [value] # text | Title of the original
# manifest: [value] # URL - Absolute path | OKH manifest location
# web: [value] # URL - Absolute path | web presence location
#variant-of:
# title: [value] # text | Title of the original
# manifest: [value] # URL - Absolute path | OKH manifest location
# web: [value] # URL - Absolute path | web presence location
#sub:
# title: [sub 1] # text | Title of the original
# manifest: [value] # URL - Absolute path | OKH manifest location
# web: [value] # URL - Absolute path | web presence location
# License
license: # At least one license is required | The format should be an SPDX identifier. See https://spdx.org/licenses/hardware: [value] # recommended | The license under which the hardware is released
hardware: [value] # recommended | The license under which the documentation is released
documentation: [value] # recommended | The license under which the documentation is released
software: [value] # recommended where software is used | The license under which the software is released
#licensor:
# name: [value] # text
# affiliation: [value] # text
# email: [value] # email address
# Documentation
documentation-home: [value] # At least one of the project-link or documentation-home fields is required | absolute path
#archive-download: [value] # Absolute or relative path
#design-files: # recommended
# - path: [value] # Absolute or relative path
# title: [value] # text
#schematics: # recommended where applicable
# - path: [value] # Absolute or relative path
# title: [value] # text
#bom: [value] # recommended | absolute or relative path | Direct the maker to the Bill of Materials
#tool-list: [value] # recommended | absolute or relative path | Direct the maker to a list of tools required to make the thing
#making-instructions: # recommended
# - path: [value] # Absolute or relative path
# title: [value] # text
#manufacturing-files: # recommended where applicable
# - path: [value] # Absolute or relative path
# title: [value] # text
#risk-assessment: # recommended
# - path: [value] # Absolute or relative path
# title: [value] # text
#tool-settings: # recommended where applicable
# - path: [value] # Absolute or relative path
# title: [value] # text
#quality-instructions:
# - path: [value] # Absolute or relative path
# title: [value] # text
#operating-instructions: # recommended
# - path: [value] # Absolute or relative path
# title: [value] # text
#maintenance-instructions: [value] # recommended
# - path: [value] # Absolute or relative path
# title: [value] # text
#disposal-instructions: [value] # recommended
# - path: [value] # Absolute or relative path
# title: [value] # text
#software: # recommended where applicable | Source code or executable software that the thing uses
# - path: [value] # Absolute or relative path
# title: [value] # text
# User defined Fields
# Include any custom / extended fields here