OSH project directory structure standards

Motivation

Why do we need directory standards?

1. to be able to extract meta-data:
   1. easy indexing (and thus finding) of projects
   2. easy comparing of projects
   3. allows to write software tools that deal with project repos
2. find your way around quickly and easily in different projects

Standards documented in this repo

• Prusaish: Promotes a practical, minimal style, with emphasis on sources, and git sub-modules for firmware and scripts. Most directories are named after the file-type (i.e. suffix or software) they contain.

• Unixish (favored): Each sub-part (aka module) is in a sub-directory of its own, and internally uses the same structure like in the project root, recursively. Most directories are named after the abstract/generic function of their content.

Other structure templates

• https://www.sciencedirect.com/journal/hardwarex
• https://osf.io/wgk7q/

License

The most relevant content of this repo is licensed under the GFDL-1.3-or-later. Use the REUSE tool (reuse spdx) for more details.

Funding

This project was funded by the European Regional Development Fund (ERDF) in the context of the INTERFACER Project, from January 2022 (project start) until March 2023.