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

Spruce up our README #60

Open
danyeaw opened this Issue Oct 8, 2018 · 2 comments

Comments

Projects
None yet
2 participants
@danyeaw
Member

danyeaw commented Oct 8, 2018

I'm submitting a...

  • Bug report
  • Feature request
  • Documentation issue or request

We would ❤️ someone to craft a new README. We need a better description of what Gaphor is and is not, a nice gif showing it in action, and details about how to install it on the different platforms.

A good starting point may be to get the sections setup first, and then we can get the information added. https://github.com/matiassingers/awesome-readme has many resources and examples showing great READMEs for other projects.

@esantoro

This comment has been minimized.

Show comment
Hide comment
@esantoro

esantoro Oct 8, 2018

Hello, can I work on this? Can you assign this issue to me ?

esantoro commented Oct 8, 2018

Hello, can I work on this? Can you assign this issue to me ?

@danyeaw

This comment has been minimized.

Show comment
Hide comment
@danyeaw

danyeaw Oct 8, 2018

Member

Hi @esantoro, buongiorno! We would love to have your help with this. The GitHub Assignees only allows assigning issues to current contributors, but I'll remove the up-for-grabs label, and it is all yours to work on!

Member

danyeaw commented Oct 8, 2018

Hi @esantoro, buongiorno! We would love to have your help with this. The GitHub Assignees only allows assigning issues to current contributors, but I'll remove the up-for-grabs label, and it is all yours to work on!

@danyeaw danyeaw removed the up-for-grabs label Oct 8, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment