This is a work-in-progess in early stages.
This repo is modeled after the Arduino Library Registry and the way it works. The idea is to allow new open source hardware projects to be registered here by making a pull request against a simple flat file that adds a new project. In this way the public is encouraged to add new projects.
However, the Arduino community is mature and has a standardized and accepted in the libary.json file format. No consensus has yet formed in the open source hardware community, although we advocate the Open Know-How (OKH) standard.
We are seeking a registry that can take advantage of the OKH, but does not rely on it, or even depend on git as a hosting mechanism.
The osh-registry.json file format uses JavaScript Object Notation (JSON) to define entries.
The file itself is technically a list of JavaScript objects.
A prototypical entry looks something like:
{
"name": "VentMon",
"projectOrRegistry": "project",
"keywords": "spirometer, respiration, Arduino, ESP32",
"description": "VentMon: An open source IoT-enabled spirometer for testing medical ventilators",
"okhURL": "https://github.com/PubInv/ventmon-ventilator-inline-test-monitor/blob/master/ventmon-okh.yml",
"browseToUrl": "https://www.pubinv.org/project/ventmon/",
"repository": {
"type": "git",
"url": "https://github.com/PubInv/ventmon-ventilator-inline-test-monitor"
},
"hardwareLicense": "CERN-OHL-S",
"authors": [
{
"name": "Robert L. Read",
"email": "[email protected]",
"url": "https://github.com/RobertLRead",
"maintainer": true
},
{ "name": "Ben Coombs"},
{ "name": "Lauria Clarke"}
],
"makers": [
{ "name" : "Public Invention",
"url" : "https://www.pubinv.org/"}
],
"version": "0.5",
}
When you are ready, please visit the live website.
This project is led by Robert L. Read, Christina Cole, Victoria Jaqua and Andrew Lamb.
This project is free software licensed under the GNU Affero General Public License.