A README that explains what the project is, what it does, and how it works is useful. Adding a picture of the project in action is also useful so people can see what this project looks like in practical use.
This is important to add before Imagine RIT as I used a link to this repository for our Imagine RIT booth application and also for promoting the project more widely on social media / blog posts.
Details
Something that does the following is enough:
4-5 sentences of what project is / how it works
Credits / attributions to those involved
What open source license is used for the project
Outcome
Someone can understand what this repo is when they navigate here or they are linked here on Imagine RIT website / FOSS@MAGIC website
Summary
Add README to FOSS Letters repository on GitHub
Background
A README that explains what the project is, what it does, and how it works is useful. Adding a picture of the project in action is also useful so people can see what this project looks like in practical use.
This is important to add before Imagine RIT as I used a link to this repository for our Imagine RIT booth application and also for promoting the project more widely on social media / blog posts.
Details
Something that does the following is enough:
Outcome
Someone can understand what this repo is when they navigate here or they are linked here on Imagine RIT website / FOSS@MAGIC website