How to Opensource a Project: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
Summary: | Summary: | ||
*Open-sourcing a hardware project means | *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. | ||
Revision as of 17:14, 7 July 2022
Summary:
- Open-sourcing a hardware project means:
- 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. See 4 Freedoms of Open Hardware
- 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 onDiscourse, 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.
- For hardware - certify with OSHWA - https://certification.oshwa.org/basics.html
- For software - [1]