search

Mach30 / dof

Distributed OSHW Framework - A methodology for documenting and sharing Open Source Hardware
https://mach30.github.io/dof/
Creative Commons Attribution 4.0 International
9 stars 4 forks source link

Add Content Overview In Readme.md #1

Closed jmwright closed 6 years ago

jmwright commented 6 years ago

Having at least a description of the theme of each directory would help. Right now there are just the core-assumptions and use-cases directories.

m30-jrs commented 6 years ago

I am actually in the process of completely restructuring this repo. As part of that work I will be adding descriptions of each of the directories and how to use them plus generating the top level readme and the architecture document.

m30-jrs commented 6 years ago

@jmwright - my plan is to migrate material over to the architecture yaml files and then retire the old content from the repo. Assuming this is done in concert with the production docs about the yaml file formats and the final architecture documentation, would you feel this issue is being addressed enough to close it?

jmwright commented 6 years ago

Yep. I think this has a good direction set already.