Formatted README

[ElectronicsArchiver]

 
 Please Check The Preview 
 

• Why not to use GitHub Wiki

  
  

• I didn't remove any badges, though personally I would drop the first row as those stats are either redundant or uninteresting opposed to the size, the people working on it, ..

• General formatting / spacing

• Added quicklinks

• Formatted & moved reporting issues into dedicated file

• Referenced links

• Added logo

• Unified badges

• Removed redundant licening note

• If you have any questions.

• In case you do not agree with some of the changes made in this PR, please first let me know about them, before disregarding it entirely so we can possibly find a middle ground and have it not go to waste.

 
            No, I'm not a robot.            
 

 
    Yes, you are not the first.    
 

 
     I just made a PR template.     
 

If you want to know more about Markdown check out:

                            

[digitalfrost]

Looks nice, but does this mean we have to create a new badge on img.shields.io if we want to add additional sections to the README ?

Also the README is no longer very readable in a text editor.

I think the pull request is nice until line 31. This is the new header / masthead. I think the original file is nicer from line 25 onwards (the screenshot and everything underneath) as it then fulfills its function as a README.

[digitalfrost]

I agree about the redundant badges. I would also drop the first line of badges shown in the preview

[ElectronicsArchiver]

Looks nice, but does this mean we have to create a new badge on img.shields.io if we want to add additional sections to the README ?

? They are auto generated like before, you just add different text / color, that's it

Also the README is no longer very readable in a text editor.

Well if you actually cared about text only editors, the previous one wasn't that much better. If you want a text only version I can make a separate one designed for that specifically.

I think the pull request is nice until line 31. This is the new header / masthead. I think the original file is nicer from line 25 onwards (the screenshot and everything underneath) as it then fulfills its function as a README.

Well considering a README is the front page of a repo, I think it should act as such, as a hub, to get you to the content you want, not everything at once, not things you didn't ask for.

Showcase some stuff, link to resources, that's it, just like project websites do.

I agree about the redundant badges. I would also drop the first line of badges shown in the preview

Guess I should still wait on what a maintainer rules..

[jellespijker]

@Joeydelarago Since you recently worked on the documentation can you take a look at this one?

[Joeydelarago]

Hey, thanks for the contribution. The new README looks really slick. I'll most likely go through our other repositories and copy this style. If you see I haven't done it yet, feel free to take the work off my hands. Just request my review on the pull request and I will check it out.