Commit 9349ac0c authored by Javier Serrano's avatar Javier Serrano

Javier's feedback

parent ab9085c4
......@@ -57,12 +57,12 @@ hardware, and under the CERN-OHL-S v2 in particular.
\label{subsec:your-sources}
Nowadays, most designers who intend to share their work do so by hosting their
design files (sources) in a publicly-accessible repository using version-control
design files (sources) in a publicly-accessible repository using version control
systems such as git. The sites hosting these repositories usually provide users
with the convenience of downloading a whole repository as a compressed (e.g.
zip) file. This is a very effective way of working: it makes it easier for you
to receive feedback, shows your users the complete history of the project and
allows them to easily start using it and contributing improvements.
zip) file. Using these platforms is a very effective way of working: it makes it
easier for you to receive feedback, shows your users the complete history of the
project and allows them to easily start using it and contributing improvements.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.1}]
\item \textbf{Suggestion: } try to host your design in a publicly-accessible
......@@ -88,19 +88,10 @@ mechanical designs can be exported to the STEP format.
source licences, provide information about where the recipient can find them.
\end{enumerate}
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.3}]
\item \textbf{Rule: } if your design is a modification of someone else's
design, or incorporates parts of another's design, and in each case the
other's design is released under CERN-OHL, CERN-OHL-W or CERN-OHL-S you must
(if your tools allow this) include in your design sources versions of the
files exported to formats everybody can read using tools available under a
free or open source software licence.
\end{enumerate}
It can also be good to let people know that you are following this guide, so
they see why you are doing things in this or that way.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.4}]
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.3}]
\item \textbf{Suggestion: } include a copy of this user guide, in pdf or plain
text format, in your sources.
\end{enumerate}
......@@ -112,11 +103,11 @@ URL pointing to the licence text, but it does not hurt to include the licence
text in the source package for the convenience of the user and to make it very
visible that the whole design is open source.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.5}]
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.4}]
\item \textbf{Suggestion: } include a copy of the CERN-OHL-S v2 licence text,
in pdf or plain text format, in your sources, and failing that, provide a link
to the licence at
\href{https://ohwr.org/cern_ohl_s_v2.pdf}{https://ohwr.org/cern\_ohl\_s\_v2.pdf
\href{https://ohwr.org/cern_ohl_s_v2.txt}{https://ohwr.org/cern\_ohl\_s\_v2.txt
}.
\end{enumerate}
......@@ -125,7 +116,7 @@ publish those modifications is to make them explicit in a dedicated text file.
As a licensor, you can make this obligation more easy for licensees to see and
bear in mind by including a placeholder file called CHANGES.txt in your sources.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.6}]
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.5}]
\item \textbf{Suggestion: } include an empty CHANGES.txt file in your sources.
You may write a few lines in the beginning of the file stating that anyone
modifying the design should provide brief information about the modifications,
......@@ -134,10 +125,7 @@ bear in mind by including a placeholder file called CHANGES.txt in your sources.
that, according to section 3.3.b of the licence, licensees should provide a
brief entry with a date and the nature of the modification for each design
change. For example `26 April 2020: AC/DC power converter circuit removed as
AC input no longer necessary'. You can make this obligation easier to manage
by making your design modular in the first place (so that the CHANGES.txt file
does not accumulate information from parts of designs which you are not
using).
AC input no longer necessary'.
\end{enumerate}
Now, as you have seen, as the initial licensor, relatively few rules apply to
......@@ -145,7 +133,7 @@ you. We are going to assume that it is your intent to license your design under
CERN-OHL-S v2 though, and in that sense the minimal requirements are going to be
described as `rules' below.
Some files can easily include a header of a text box with copyright and
Some files can easily include a header or a text box with copyright and
licensing information which will be easily visible to whoever opens them. For
file types which do not easily grant that possibility, consider using a separate
text file taking as its name the name of the original file with
......@@ -157,7 +145,7 @@ text file taking as its name the name of the original file with
`my\_3d\_design.FCStd.license' which is a text file containing copyright and
licensing information.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.7}]
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.6}]
\item \textbf{Rule: } include for each source file, either embedded in the file
itself or in a separate text file which refers to it:
\begin{enumerate}
......@@ -179,6 +167,8 @@ licensing information.
\end{enumerate}
\end{enumerate}
\pagebreak
Here is an example for a hypothetical designer called Sam Smith hosting a design
called Gizmo at https://example\_url:
......@@ -188,10 +178,14 @@ called Gizmo at https://example\_url:
This source describes Open Hardware and is licensed under the CERN-OHL-S v2.
\\
You may redistribute and modify this source and make products using it under
the terms of the CERN-OHL-S v2 (https:/cern.ch/cern-ohl). This source is
distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING OF
MERCHANTABILITY, SATISFACTORY\\QUALITY AND FITNESS FOR A PARTICULAR PURPOSE.
Please see the CERN-OHL-S v2 for applicable conditions.
the terms of the CERN-OHL-S v2
\\
(\href{https://ohwr.org/cern_ohl_s_v2.txt}{https://ohwr.org/cern\_ohl\_s\_v2.txt
}).
\\
This source is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY,
INCLUDING OF MERCHANTABILITY, SATISFACTORY\\QUALITY AND FITNESS FOR A
PARTICULAR PURPOSE. Please see the CERN-OHL-S v2 for applicable conditions.
\\
Source location: https://example\_url
\\
......@@ -206,12 +200,12 @@ type, can be substituted by a valid SPDX header, like this:
\noindent SPDX-FileCopyrightText: 2020 Sam Smith \textless
sam@example.com\textgreater\\ SPDX-License-Identifier: CERN-OHL-S-2.0
or, in case the `or later' version is preferred:
or, in case the `or later' option is preferred:
\noindent SPDX-FileCopyrightText: 2020 Sam Smith \textless
sam@example.com\textgreater\\ SPDX-License-Identifier: CERN-OHL-S-2.0+
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.8}]
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.7}]
\item \textbf{Suggestion: } use standard SPDX headers whenever possible so that
your choice of licence is easy to understand by humans and computers alike.
\end{enumerate}
......@@ -229,7 +223,7 @@ so we thought we'd mention it in this guide. You have to make your own judgment
as to whether you believe that CERN can be trusted to ensure that future
versions of the CERN-OHL will be similar in spirit and effect to this version.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.9}]
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.8}]
\item \textbf{Suggestion: } give some thought to the `or later' option before
publishing your design under CERN-OHL-S v2.
\end{enumerate}
......@@ -238,7 +232,7 @@ We are going to assume that you, as a licensor, want people who receive a produc
based on your design to know that it is Open Hardware and where they can find
the design files for that product, hence:
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.10}]
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.9}]
\item \textbf{Rule: } include in a part of the Source corresponding to a visible
part of the Product (e.g. silkscreen or top copper for a printed circuit
board):
......@@ -246,13 +240,15 @@ the design files for that product, hence:
\item the licence notice: “Licensed under CERN-OHL-S v2”;
\item the Source Location.
\end{enumerate}
\item \textbf{Suggestion: } You can optionally include a copyright notice to
be printed on the Product (remember you must keep intact any Notices in the
source, though), but do \emph{not} include the CERN logo. You may include a
copyright notice. If you do, and your design includes part of other designs,
you should at least acknowledge the work is not all your own by using e.g.
Copyright \textcopyright 2020 Sam Smith and others.
\end{enumerate}
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.10}]
\item \textbf{Suggestion: } You can optionally include a copyright notice to be
printed on the Product (remember you must keep intact any Notices in the
source, though). If you do, and your design includes part of other designs,
you should at least acknowledge the work is not all your own by using e.g.
Copyright \textcopyright~2020 Sam Smith and others. In any case, do \emph{not}
include the CERN logo.
\end{enumerate}
\subsection{A Note on Components}
......@@ -271,7 +267,7 @@ particular design detailed in the accompanying licence. If you receive hardware
designs licensed under the CERN-OHL-S v2, the requirements are to:
\begin{enumerate}[label=\textbf{\ref*{sec:receive-designs}.1}]
\item \textbf{Rule: } keep intact all the copyright, acknowledgment and
\item \textbf{Rule: } keep intact all the copyright, acknowledgement and
trademark notices and Source Location notices that are on the hardware design
sources.
\end{enumerate}
......@@ -318,6 +314,16 @@ products, you must:
components of the design allow you to license with the `or later' option).
\end{enumerate}
\begin{enumerate}[label=\textbf{\ref*{subsec:modify-designs}.5}]
\item \textbf{Rule: } if your design is a modification of someone else's design,
or incorporates parts of another's design, and in each case the other's design
is released under CERN-OHL\footnote{By CERN-OHL we mean any of the earlier
versions of the licence, prior to v2.0.}, CERN-OHL-W or CERN-OHL-S you must
(if your tools allow this) include in your design sources versions of the
files exported to formats everybody can read using tools available under a
free or open source software licence.
\end{enumerate}
\subsection{Hardware production and distribution}
\label{subsec:make-hardware}
If, as a licensee, you want to produce hardware based on a design licensed under
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment