search

rkd77 / elinks

Fork of elinks
Other
350 stars 38 forks source link

Problems with README.md #286

Open b9Joker108 opened 8 months ago

b9Joker108 commented 8 months ago

Hi

Thank you so much for developing this project!

First, I just wanted to remind you about the project's official website, and that it hasn't been updated for a number of versions of releases, and could really do with some attention.

Second, I made a fork of the repository to make some edits to the README.md. But, when I went to edit the source code, I couldn't determine the problem, like I thought I would be able to do. So, I resolved just to send an issue notification.

I have downloaded elinks on my tablet with Termux.

I found my way to the repository in GitHub and was reading the README.md document. It is really annoying to read and navigate on my tablet because the body of the text apart from the title, is in a code block as it is copyable by clicking on the one little button. This is unnecessary, given the nature of the content, as it isn't code. It is annoying, because how it renders on my screen, quite alot of information is not visible and is obfuscated. To view the end of every line of text which is obfuscated, I need to manually use my capacitive touchscreen to navigate across to the right and then back to he left, for the start of the next line. This becomes really annoying and cumbersome in order to read the entire document on my tablet. I thought that the body of the text would just either be coded in Markdown, as being in a code box, by either the starting tilde (~), or be surrounded or framed by the three backticks at start and closure, but this is not the case. So, I could not determine what in Markdown was making the body of the text bar the heading, render in a code box. Therefore, I couldn't make the edits in the fork myself, to make it easy for you, and make a push request. I ask you to please make these changes, as the code block does a disservice in rendering, viewing and reading the README.md in Markdown.

Cheers Beauford

rkd77 commented 8 months ago

Which software are you using to see or modify README.md ?

rkd77 commented 8 months ago

I converted from asciidoc to markdown. Is more readable now?