How to Opensource a Project - Revision history

Marcin at 17:23, 7 July 2022

2022-07-07T17:23:39Z

← Older revision		Revision as of 17:23, 7 July 2022
Line 1:		Line 1:
	Summary:		Summary:
	*Open-sourcing a hardware project means creating public documentation to which anyone can contribute to build upon existing work. This starts with publishing any existing designs openly on the internet. In practice:		*Open-sourcing a hardware project means creating public documentation to which anyone can contribute to build upon existing work. This starts with publishing any existing designs openly on the internet. In practice:
	**Creating a public repository where you upload your designs and documentation. This could be a wiki, a website, or [[GitLab]]. You can use existing platforms such as the [[OSE ~~Wiki]]~~, [[Appropedia]], or others.		**Creating a public repository where you upload your designs and documentation. This could be a wiki, a website, or [[GitLab]]. You can use existing platforms such as the OSE wiki, [[Appropedia]], or others.
	**Allowing the use of your designs and documentation for any purpose, including selling the finished product. See [[4 Freedoms of Open Hardware]]. This terms are declared in a license.		**Allowing the use of your designs and documentation for any purpose, including selling the finished product. See [[4 Freedoms of Open Hardware]]. This terms are declared in a license.
	**Declaring or creating a license - which shows the terms under which your documentation must be shared. This license should be clearly visible in the public face of the project.		**Declaring or creating a license - which shows the terms under which your documentation must be shared. This license should be clearly visible in the public face of the project.
	**Developing a contributor community - making it easy for others to download, study, modify, and share improvements. Creating a public repository such as a wiki, website, or GitHub/Gitlab. Setting up a communication platform, such as public forums on[[Discourse]], an email list, or other project management, for communication purposes. Clear contributor guidelines and communication channels are key, and license clarity allows anyone to understand whether a project is open source - or proprietary.		**Developing a contributor community - making it easy for others to download, study, modify, and share improvements. Creating a public repository such as a wiki, website, or GitHub/Gitlab. Setting up a communication platform, such as public forums on[[Discourse]], an email list, or other project management, for communication purposes. Clear contributor guidelines and communication channels are key, and license clarity allows anyone to understand whether a project is open source - or proprietary.
	**Understanding that any documentation license that is non-commercial		**Understanding that any documentation license that is non-commercial is not open source
			**For advanced collaboration - study how to engage in [[Open Source Product Development]]

	The general guidelines is to use commmonly available toolchains and workflows where these are open source and easy to access for widespread collaboration. As opposed to proprietary toolchains, which others cannot easily access, and where file formats may not be universal. Since open source hardware digital design is done in CAD software, the best practice is to use the premium open source CAD design packages such as [[FreeCAD]] or [[Blender]]. [[KiCad]] can be used for electronics, and many others.		The general guidelines is to use commmonly available toolchains and workflows where these are open source and easy to access for widespread collaboration. As opposed to proprietary toolchains, which others cannot easily access, and where file formats may not be universal. Since open source hardware digital design is done in CAD software, the best practice is to use the premium open source CAD design packages such as [[FreeCAD]] or [[Blender]]. [[KiCad]] can be used for electronics, and many others.

Marcin at 17:22, 7 July 2022

2022-07-07T17:22:13Z

← Older revision		Revision as of 17:22, 7 July 2022
Line 1:		Line 1:
	Summary:		Summary:
	*Open-sourcing a hardware project means creating public documentation to which anyone can contribute to build upon existing work. This starts with publishing any existing designs openly on the internet. In practice:		*Open-sourcing a hardware project means creating public documentation to which anyone can contribute to build upon existing work. This starts with publishing any existing designs openly on the internet. In practice:
	**Creating a public repository where you upload your designs and documentation. This could be a wiki, a website, or [[GitLab]].		**Creating a public repository where you upload your designs and documentation. This could be a wiki, a website, or [[GitLab]]. You can use existing platforms such as the [[OSE Wiki]], [[Appropedia]], or others.
	**Allowing the use of your designs and documentation for any purpose, including selling the finished product. See [[4 Freedoms of Open Hardware]]. This terms are declared in a license.		**Allowing the use of your designs and documentation for any purpose, including selling the finished product. See [[4 Freedoms of Open Hardware]]. This terms are declared in a license.
	**Declaring or creating a license - which shows the terms under which your documentation must be shared. This license should be clearly visible in the public face of the project.		**Declaring or creating a license - which shows the terms under which your documentation must be shared. This license should be clearly visible in the public face of the project.

Marcin: /* Links */

2022-07-07T17:20:02Z

Links

← Older revision		Revision as of 17:20, 7 July 2022
Line 13:		Line 13:

	=Links=		=Links=
	*[[Levels of Openness]]		*[[Levels of Openness]] - much more in-depth analysis of what open collaboration really means, and the shortcomings preventing transparent collaboration from happening
	*[[Non-~~Commercial Licenses]] are not allowed~~

Marcin at 17:18, 7 July 2022

2022-07-07T17:18:07Z

← Older revision		Revision as of 17:18, 7 July 2022
Line 9:		Line 9:
	The general guidelines is to use commmonly available toolchains and workflows where these are open source and easy to access for widespread collaboration. As opposed to proprietary toolchains, which others cannot easily access, and where file formats may not be universal. Since open source hardware digital design is done in CAD software, the best practice is to use the premium open source CAD design packages such as [[FreeCAD]] or [[Blender]]. [[KiCad]] can be used for electronics, and many others.		The general guidelines is to use commmonly available toolchains and workflows where these are open source and easy to access for widespread collaboration. As opposed to proprietary toolchains, which others cannot easily access, and where file formats may not be universal. Since open source hardware digital design is done in CAD software, the best practice is to use the premium open source CAD design packages such as [[FreeCAD]] or [[Blender]]. [[KiCad]] can be used for electronics, and many others.

	*For hardware - certify with OSHWA - https://certification.oshwa.org/basics.html		*For hardware - certify your finished product with OSHWA - https://certification.oshwa.org/basics.html
	*~~For~~ software - [https://opensource.guide/starting-a-project/]		*Best practices for software - [https://opensource.guide/starting-a-project/]

			=Links=
			*[[Levels of Openness]]
			*[[Non-Commercial Licenses]] are not allowed

Marcin at 17:17, 7 July 2022

2022-07-07T17:17:16Z

← Older revision		Revision as of 17:17, 7 July 2022
Line 1:		Line 1:
	Summary:		Summary:
	*Open-sourcing a hardware project means:		*Open-sourcing a hardware project means creating public documentation to which anyone can contribute to build upon existing work. This starts with publishing any existing designs openly on the internet. In practice:
	**Creating a public repository where you upload your designs and documentation		**Creating a public repository where you upload your designs and documentation. This could be a wiki, a website, or [[GitLab]].
	**Allowing the use of your designs and documentation for any purpose, including selling the finished product. See [[4 Freedoms of Open Hardware]]		**Allowing the use of your designs and documentation for any purpose, including selling the finished product. See [[4 Freedoms of Open Hardware]]. This terms are declared in a license.
	**Declaring a license - which shows the terms under which your documentation must be shared. This license should be clearly visible in the public face of the project.		**Declaring or creating a license - which shows the terms under which your documentation must be shared. This license should be clearly visible in the public face of the project.
	**Developing a contributor community - making it easy for others to download, study, modify, and share improvements. Creating a public repository such as a wiki, website, or GitHub/Gitlab. Setting up a communication platform, such as public forums on[[Discourse]], an email list, or other project management, for communication purposes. Clear contributor guidelines and communication channels are key, and license clarity allows anyone to understand whether a project is open source - or proprietary.		**Developing a contributor community - making it easy for others to download, study, modify, and share improvements. Creating a public repository such as a wiki, website, or GitHub/Gitlab. Setting up a communication platform, such as public forums on[[Discourse]], an email list, or other project management, for communication purposes. Clear contributor guidelines and communication channels are key, and license clarity allows anyone to understand whether a project is open source - or proprietary.
	**Understanding that any documentation license that is non-commercial		**Understanding that any documentation license that is non-commercial

Marcin at 17:14, 7 July 2022

2022-07-07T17:14:25Z

← Older revision		Revision as of 17:14, 7 July 2022
Line 1:		Line 1:
	Summary:		Summary:
	*Open-sourcing a hardware project means ~~doing 4 things~~:		*Open-sourcing a hardware project means:
	**Creating a public repository where you upload your designs and documentation		**Creating a public repository where you upload your designs and documentation
	**Allowing the use of your designs and documentation for any purpose, including selling the finished product		**Allowing the use of your designs and documentation for any purpose, including selling the finished product. See [[4 Freedoms of Open Hardware]]
	**Declaring a license - which shows the terms under which your documentation must be shared		**Declaring a license - which shows the terms under which your documentation must be shared. This license should be clearly visible in the public face of the project.
	**Developing a contributor community - making it easy for others to download, study, modify, and share improvements. Creating a public repository such as a wiki, website, or GitHub/Gitlab. Setting up a communication platform, such as public forums on[[Discourse]], an email list		**Developing a contributor community - making it easy for others to download, study, modify, and share improvements. Creating a public repository such as a wiki, website, or GitHub/Gitlab. Setting up a communication platform, such as public forums on[[Discourse]], an email list, or other project management, for communication purposes. Clear contributor guidelines and communication channels are key, and license clarity allows anyone to understand whether a project is open source - or proprietary.
			**Understanding that any documentation license that is non-commercial

	The general guidelines is to use commmonly available toolchains and workflows where these are open source and easy to access for widespread collaboration. As opposed to proprietary toolchains, which others cannot easily access, and where file formats may not be universal. Since open source hardware digital design is done in CAD software, the best practice is to use the premium open source CAD design packages such as [[FreeCAD]] or [[Blender]]. [[KiCad]] can be used for electronics, and many others.		The general guidelines is to use commmonly available toolchains and workflows where these are open source and easy to access for widespread collaboration. As opposed to proprietary toolchains, which others cannot easily access, and where file formats may not be universal. Since open source hardware digital design is done in CAD software, the best practice is to use the premium open source CAD design packages such as [[FreeCAD]] or [[Blender]]. [[KiCad]] can be used for electronics, and many others.

Marcin at 17:11, 7 July 2022

2022-07-07T17:11:46Z

← Older revision		Revision as of 17:11, 7 July 2022
Line 4:		Line 4:
	**Allowing the use of your designs and documentation for any purpose, including selling the finished product		**Allowing the use of your designs and documentation for any purpose, including selling the finished product
	**Declaring a license - which shows the terms under which your documentation must be shared		**Declaring a license - which shows the terms under which your documentation must be shared
	**Developing a contributor community - making it easy for others to download, study, modify, and share improvements. Creating a public repository such as a wiki, website, or GitHub/Gitlab. Setting up a communication platform, such as [[Discourse ~~Forum~~]]		**Developing a contributor community - making it easy for others to download, study, modify, and share improvements. Creating a public repository such as a wiki, website, or GitHub/Gitlab. Setting up a communication platform, such as public forums on[[Discourse]], an email list

			The general guidelines is to use commmonly available toolchains and workflows where these are open source and easy to access for widespread collaboration. As opposed to proprietary toolchains, which others cannot easily access, and where file formats may not be universal. Since open source hardware digital design is done in CAD software, the best practice is to use the premium open source CAD design packages such as [[FreeCAD]] or [[Blender]]. [[KiCad]] can be used for electronics, and many others.

	*For hardware - certify with OSHWA - https://certification.oshwa.org/basics.html		*For hardware - certify with OSHWA - https://certification.oshwa.org/basics.html
	*For software - [https://opensource.guide/starting-a-project/]		*For software - [https://opensource.guide/starting-a-project/]

Marcin at 17:08, 7 July 2022

2022-07-07T17:08:18Z

← Older revision		Revision as of 17:08, 7 July 2022
Line 1:		Line 1:
			Summary:
			*Open-sourcing a hardware project means doing 4 things:
			**Creating a public repository where you upload your designs and documentation
			**Allowing the use of your designs and documentation for any purpose, including selling the finished product
			**Declaring a license - which shows the terms under which your documentation must be shared
			**Developing a contributor community - making it easy for others to download, study, modify, and share improvements. Creating a public repository such as a wiki, website, or GitHub/Gitlab. Setting up a communication platform, such as [[Discourse Forum]]

	*For hardware - certify with OSHWA - https://certification.oshwa.org/basics.html		*For hardware - certify with OSHWA - https://certification.oshwa.org/basics.html
	*For software - [https://opensource.guide/starting-a-project/]		*For software - [https://opensource.guide/starting-a-project/]

Marcin: Created page with "For hardware - certify with OSHWA - https://certification.oshwa.org/basics.html For software - [https://opensource.guide/starting-a-project/]"

2022-07-07T17:04:39Z

Created page with "*For hardware - certify with OSHWA - https://certification.oshwa.org/basics.html *For software - [https://opensource.guide/starting-a-project/]"

New page

*For hardware - certify with OSHWA - https://certification.oshwa.org/basics.html
*For software - [https://opensource.guide/starting-a-project/]