readme.md in each source directory to describe what it does

BrewPi / firmware

Brewing temperature control firmware for the BrewPi Spark (Particle Photon inside)

http://www.brewpi.com

GNU Affero General Public License v3.0

97 stars 55 forks source link

readme.md in each source directory to describe what it does #29

Open m-mcgowan opened 9 years ago

m-mcgowan commented 9 years ago

Makes it easier for newcomers to know where to put source code and where to look to find existing sources.

Also an overview of the main folder structure in the root readme.md would be useful.

a2hill commented 8 years ago

This would be very helpful. I'm interested in helping or poking around at the very least, but honestly I'm not too sure where to start. The main project readme isn't too helpful either