Skip to content
Code-Schnipsel Gruppen Projekte
Readme.md 930 B
Newer Older
Florian Rabis's avatar
Florian Rabis committed
# Project Title

- this is a template for a `Readme`, especially for Open Source Hardware Projects

## Project Description

- this repository is just for teaching purposes


## Current Status (active, archived, moved, ...)

- active maintained


## Dependencies

- are referenced as submodules:
    - `osh-dir-std`-Directory Standard for OSH-Repositorys
    - `OpenKnowHow`-Meta-Data-Specification for OSH-Projects
    - `reuse-tool` for License-Management (SPDX)
    - `osh-tool` for validation of OSH project design compliance
    - `OSH-3105` DIN-SPEC-3105: OSH Documentation Standard


## Project structure

- describe the structure of the project
- reference standards and conventions


## Documentation

- where can someone find the full documentation, especially when it is in a separate repository or website
 

## Contribution Guidelines

- how can somebody contribute to the project


## License

- licensing information