Android-UVC-Camera icon indicating copy to clipboard operation
Android-UVC-Camera copied to clipboard

README issues

Open umlaeute opened this issue 2 weeks ago • 0 comments

i'm trying to setup my camera with your app, and have troubles with the README.

the text itself is quite long, so it is not really helpful to be able to follow the README within the application, as you can either see the instructions or follow the instructions (filling in values,...) - not both at the same time.

so I just opened my favourite browser on my laptop and opened up https://github.com/Peter-St/Android-UVC-Camera and the README is here all right.

Unfortunately, it uses tag-like formatting for literal content, e.g. https://github.com/Peter-St/Android-UVC-Camera/blob/912debe31b6ccd0bcf76f2e5520594a804caea26/README.md?plain=1#L54

github markdown renderer, displays this as

So you click the Button and then the Button . The app will ask you for granting the permissions.

which is not very helpful. (of course there are many more similar occurrences things like <some really important text>, which are all rendered as blanks)

so you have to switch to the raw view of the markdown file, which is also rather unreadable, because the lines are up to 321 characters long (so you have to do a lot of scrolling, and there's no images).

it would be fantastic if you could

  • wrap your lines at ~72 characters
  • use a different way to mark important text. typically markdown bold (**some really important text**) or code (`bla`) would hopefully be a better choice (it's not as if the in-app rendering of the markdown would make any special use of the angular brackets)

apart from that, i think there are a number of spelling mistakes (both in the english version and in the in-app german version)

umlaeute avatar Feb 07 '25 08:02 umlaeute