Improved README.md

[drkhsh]

• Headlines
• Line breaks
• Grammar
• Typos
• License notice

[bentolor]

Not a project member: Just stumbled over the lurid MR title.

On comparing the original with your reworked version I'd rather title this merge request "Way worse formatted and readable README.md"

The original version is clearly much better readable on source-code level on every level. To sad that your MR mixes actual very good content improvements with a very subjective overall formatting rehaul.

[drkhsh]

@bentolor

Not a project member: Just stumbled over the lurid MR title.

If you are not a project member, please do not drop such pointless comments. If you have to say something suggestive, feel free to do that. But do not criticize non-existent problems.

On comparing the original with your reworked version I'd rather title this merge request "Way worse formatted and readable README.md"

If the file's name is README.md it implies that it is formatted in Markdown, which was not fully used in this example. So I improved it by using the whole potential of this markup language.

To sad that your MR mixes actual very good content improvements with a very subjective overall formatting rehaul.

Please note: Everything is "subjective", there is no "objective". I just wanted to contribute something to some of my favourite projects (on smartphones). And as Android development totally sucks I contributed some documentation. By doing that I formatted it, so that it is way more readable in my opinion.

[licaon-kter]

You've kept Android device ecryption c'mon.

[drkhsh]

@licaon-kter what? please specify clear critisism

[licaon-kter]

Really? Third word has a typo...

[drkhsh]

@licaon-kter oh sorry :smile: c'mon if this is your critisism I will laugh. hard.

[licaon-kter]

No, it's just when you announce stuff with "Way better...", your stuff must be WAY better, you see.

[drkhsh]

@licaon-kter I hate android development as hell. It sucks and sucks and sucks. And I try to do at least something. Contributors are rare in unknown open source projects like this and if someone contributes something people should be happy, not criticize single words. Ok "way better" is exaggerated but c'mon

[bentolor]

@drkh5h I'm sorry that my comment offended you so much and missed to communicate my point.

If you have to say something suggestive, feel free to do that.

Common best practices typically mention:

• "Avoid reformatting or refactoring code w/o asking the project owner"
• "Try to keep changes as small as possible for easier reviews"

You can read about this and some other good practices in more detail i.e. here or here.

Following this best practices will make it a lot easier for the maintainer to review your changes and integrate them faster and easier.

[drkhsh]

@bentolor Ok, thanks!