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

Rewrite Readme #540

Closed
mattlockyer opened this issue Mar 27, 2016 · 6 comments
Closed

Rewrite Readme #540

mattlockyer opened this issue Mar 27, 2016 · 6 comments
Labels
Milestone

Comments

@mattlockyer
Copy link
Contributor

Even as a developer I found your readme elitist and offensive.

There's always a nice alternative to get your point across, consider:

Impress.js was written for developers and requires some basic knowledge of HTML, CSS and JavaScript to create something amazing.

@FagnerMartinsBrack
Copy link
Member

@mattlockyer

Can you please elaborate why the readme was elitist and offensive? Specifically in which points?

I ask this because the readme is on for years and AFAIK this is the first time someone reports something like this, if the readme make someone feel offended, we will gladly change it.

@mattlockyer
Copy link
Contributor Author

This paragraph:

"If you have no idea what I mean by that, or you just clicked that link above and got very confused by all these strange characters that got displayed on your screen, it's a sign, that impress.js is not for you."

Could be rephrased as I mentioned in my comment.

By referring to your repository as "may not be for you" you are discouraging use, for example a novice developer who may think you are referring to them, but may be able to use impress.

I simply don't see the point of this language as it appears to draw some special line in the sand between devs and "others".

This does not help others in an industry that already suffers from such a stigma.

@FagnerMartinsBrack
Copy link
Member

I agree and I am pretty sure @impress/mergers will be ok with that, want to create a Pull Request?

@mattlockyer
Copy link
Contributor Author

Done, thanks for letting me help out.

On Sun, Mar 27, 2016 at 9:30 PM Fagner Brack notifications@github.com
wrote:

I agree and I am pretty sure @impress/mergers
https://github.com/orgs/impress/teams/mergers will be ok with that,
want to create a Pull Request?


You are receiving this because you were mentioned.
Reply to this email directly or view it on GitHub
#540 (comment)

@FagnerMartinsBrack
Copy link
Member

Just a X-ref: #542

@FagnerMartinsBrack
Copy link
Member

I made some comments there cause it seems more stuff was changed than just the first paragraph. Let me know if you are aware of how to change the Pull Request after it is sent, if not I can change it for you when I commit it into master.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants