Skip to content

Latest commit

 

History

History
51 lines (41 loc) · 1.78 KB

README.md

File metadata and controls

51 lines (41 loc) · 1.78 KB

Prusaish - OSH project directory structure standards

This repository exemplifies a minimal template for the structure of Free/Open source hardware projects.

It promotes a practical, minimal style, with emphasis on sources, organisation for CAD files and documentation, and git sub-modules for firmware and scripts. Most directories are named after the file-type (i.e. suffix or software) they contain.

Definition

This standards machine-readable definition, can be found in various formats here:

  • definition.csv (format) - source, machine-readable, contains all the data - use this for editing
  • file-listing - like the output of find in a sample repo - generated
  • tree - like the output of tree in a sample repo - generated, recommended for inspection

Guiding principles & Inspirations

This standard is roughly derived from the Prusa repo and a few repos by Daniele Ingrassia

Some of the inspirations: