spencermwoo/anonymouth

Fix README.md

Opened this issue · 9 comments

SpencerWoo commented
  • The README.md can be reduced and simplified a lot.
  • The README.md has invalid links or old links (linking to previous repo).

For example

Java 7 is required to run Anonymouth. If you don't yet have it, get it at Oracle's website here and follow the installation instructions provided there.

and other sections should be changed to bullet lists such as

SpencerWoo commented

Links were fixed with 2ffb195 but I'd still want the README.md to be simplified and reduced.

Personally I'd eliminate any "helper" words and just have a strict, sterile, technical README but feel free to use your discretion.

santoshkumarkannur commented

Hi Sir,
I am new to github. I just want to contribute by fixing typos in README.md. Can I do it and will I be eligible for Hacktoberfest 2019?
5 typo fixes = 5 PRs, is that okay?

SpencerWoo commented

@santoshkumarkannur welcome to github!

thanks for asking -- it's preferable to group the fixes into one PR however I'll allow 4 PR changes to the README.md for hacktoberfest. If possible do more refactoring / make them more substantial but in the end I'll merge them regardless as long as they aren't introducing issues.

thanks

jjjimenez100 commented

Let me help with this one. :D

santoshkumarkannur commented

Hi Sir,
I am new to github. I just want to contribute by fixing typos in README.md. Can I do it and will I be eligible for Hacktoberfest 2019?
5 typo fixes = 5 PRs, is that okay?

Thank you Sir.

santoshkumarkannur commented

@santoshkumarkannur welcome to github!

thanks for asking -- it's preferable to group the fixes into one PR however I'll allow 4 PR changes to the README.md for hacktoberfest. If possible do more refactoring / make them more substantial but in the end I'll merge them regardless as long as they aren't introducing issues.

thanks

Hi Sir, I don't know what went wrong but my PR is labeled as "invalid". I don't have much idea on how to do it as I am new to GitHub. Is there anything I can do in order to win the Hacktoberfest?
Thanks

SpencerWoo commented

If other people find this and want to complete Hacktoberfest here are some other README.md changes that should be made are the following

  • Various hyperlinks are incorrectly linking to origin repo or contributor repos
  • The hyperlinks to internal repo code should be relative links instead of absolute.
  • Remove TODO section and convert those into Issues to be worked on in this repository.

Feel free to use your discretion if you see other ways it can be improved.

pedrohcavalcante commented

Remove TODO section and convert those into Issues to be worked on in this repository.

Created on PR #20