brentstineman / ButtonPong

A sample lab that demonstrates a simple game using Azure Serverless and Particle Internet Button Devices
MIT License
4 stars 14 forks source link

ReadMe: Content Updates and Splitting #16

Closed jsquire closed 6 years ago

jsquire commented 6 years ago

Overview

This set of changes has the primary goal of enhancing the documentation contained in the ReadMe files, both by adding more content and context and by splitting out the content into multiple files to reduce the overall "wall of text" effect.

Organization

The root contains a ReadMe that describes the general project and repository. Each area of the repository now contains a dedicated ReadMe that documents it, specifically, including ideas for enhancement to that particular area.

Pending Changes

This was a lot of text; I'm sure that I screwed things up. There are bound to be typos and places where I didn't do as good of a job normalizing the voice and tone of the content as I would have liked. I'll continue to do editorial passes and refine things moving forward.