-
Notifications
You must be signed in to change notification settings - Fork 313
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
Improve README #211
Improve README #211
Conversation
Thanks again for improving the documentation. Regarding your point about having links inline within documentation (and not as numbered links at the bottom), it is probably a matter of taste, but to me having numbered links makes the text more readable when editing. I understand your point that you have to scroll to the top and the bottom to see where it is pointing to, but links are mostly changed quite rarely, but editing the documentation is done a bit more often, and IMO, makes the text a bit more readable when editing. |
No problem. When you merged |
No, that was not intended. I will revert it. I resolved conflicts and will merge this PR now, and will revert the Features formatting again. |
I just checked the README on master and the features block has ``` and not |
Thanks for merging it. Though my point was that (regardless of whether |
Yes, I remember our discussion now. I guess the reason why I had it in the first place was to highlight the block, and that was a noob way of doing it. I just edited it and I agree that it looks better without the code formatting. I will remove it. |
Notable changes:
Java
,Zip4j
,GitHub
,API
zip
Additionally in my opinion it would be good to change all links to inline links (
[link text](https://example.com)
) instead of using link references (except maybe link 7 which is used twice) because it is rather inconvenient when editing the README to have to look at the end of the file to find out where a link leads to.Maybe for "CP437" it might also make sense to add a link to the Wikipedia article?