Rewriting the README - Githubissues

endangereddataweek / resources

Resources for planning, hosting, and promoting EDW events. All resources are CC-BY unless otherwise noted.

MIT License

13 stars 8 forks source link

Rewriting the README #5

Closed hepplerj closed 5 years ago

hepplerj commented 6 years ago

As per the guidelines with Open Leaders, we need to work on rewriting our README which, right now, is pretty bare bones.

We need to answer:

[x] what you're doing, for who, and why
[x] what makes your project special and exciting
[x] how to get started
[x] where to find key resources

🚨Avoid jargon🚨

brandontlocke commented 6 years ago

I made a few minor changes (which Github helpfully documents!). The only major-ish thing I changed was "PRs Welcome" to "Contributions Welcome." I didn't understand what that meant until I hovered on the link, and I would imagine that others wouldn't either?

svmelton commented 6 years ago

Let's think about ways that we might be able to make the readme more visual/less text heavy!