Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README to introduce project (with picture) #9

Open
jwflory opened this issue Apr 16, 2019 · 0 comments
Open

Add README to introduce project (with picture) #9

jwflory opened this issue Apr 16, 2019 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@jwflory
Copy link
Member

jwflory commented Apr 16, 2019

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:

  • 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

@jwflory jwflory added the enhancement New feature or request label Apr 16, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants