A paragraph or two giving an overview of the project. Give a brief description of each program. The goal is to quickly get new members up to speed.
Go more in-depth here on each component. Explain the purpose of the component, what technologies it uses, how it interacts with the other components, where it is in the project, and the current state of it. This can be several paragraphs long. The hope is that it answers any questions someone working on this component might have.
- Link to useful resources
- They can link to in depth information