README Rework

[ElectronicsArchiver]

 
 Please Check The Preview 
 

• Choose A License

  ⤷ https://choosealicense.com/licenses/

  ⤷ License Badges

  
  

• General formatting / spacing

• 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 are new to GitHub and aren't sure how to accept commits,
please familiarize yourself with the basics of Git / GitHub first.

Pull Requests

To accept pull requests you simply have to
press the      Merge PullRequest      button.

Never Copy-Paste Someones Contribution,
this robs them off their attribution and is thus
just plain copyright theft.

If you want to know more about Markdown check out:

                            

[ElectronicsArchiver]

@jaynetics Please review this PR~

[jaynetics]

i'm not a fan of the extra level of indirection introduced by these link references. i'd rather have my README easy to edit. the indirection would only make sense if the same link was repeated often, IMO.

[ElectronicsArchiver]

No.

the indirection would only make sense if the same link was repeated often, IMO.

Just no.

The sole purpose of link references isn't to be used for multiple similar links, it's to decouple the content from the location it's pointing to.

easy to edit

Easy to edit? You call having to edit a link in a reference difficult compared to editing it in the flow of text? Seems quite the opposite considering I added a dedicated section for that, you now don't have to select two varying point in the flow of text but rather just a static start.

[jaynetics]

please use a lowercase b - it is lowercase on purpose

[ElectronicsArchiver]

Sure, usually isn't so assumed it wasn't on purpose.

[jaynetics]

most typographers would avoid mixing two types of emphasis (bold + italic), but okay

[ElectronicsArchiver]

• Show me the stats that make you say most
• Not that I care, I'm not other people and I do mix when I see it fit.
• If you don't care then I won't change it I guess?

[jaynetics]

Suggested change

	- Self - hosting your bookmarks offers the best privacy
	- Self-hosting your bookmarks offers the best privacy

en-dashes (-) should not be surrounded by spaces

[ElectronicsArchiver]

I don't follow US conventions.
In fact I don't follow any one convention.

I take what I deem fit, if you like
it better without spaces, sure.

[jaynetics]

the spacing is another thing that makes the README a tiny bit less "maintainable" - when changing such spaced lists, people have to keep the spacing right (a small effort, but in a larger project than this one it could be problematic)

[ElectronicsArchiver]

the spacing is another thing that makes the README a tiny bit less "maintainable"

• Well you can just revert back to the good old README.txt and forget
  about formatting, that would be the easiest to maintain option.

• When changing it you could also just not adjust it like it,
  then there wouldn't be a difference to how it was before.

a small effort, but in a larger project than this one it could be problematic

This indicates to me the association of big project = big README,
which is usually a type of downfall many projects have and is in
fact not necessary in the slightest.

Btw, what did you expect me to change
to begin with, unorder them again?

[jaynetics]

thanks for the effort!

i guess i can merge it if you revert a9f0431 and rebase.

i also have a small suggestion:

in your PR template it says "Never Copy-Paste Someones Contribution, this robs them off their attribution and is thus just plain copyright theft". this might come of as a bit accusatory or hysterical, and i doubt it is legally correct :) maybe it could be phrased more like "Never copy-paste someones contribution, this robs them off their attribution and is disrespectful of their effort" or so.

[ElectronicsArchiver]

in your PR template it says "Never Copy-Paste Someones Contribution, this robs them off their attribution and is thus just plain copyright theft". this might come of as a bit accusatory or hysterical, and i doubt it is legally correct :) maybe it could be phrased more like "Never copy-paste someones contribution, this robs them off their attribution and is disrespectful of their effort" or so.

Well no.

In respect to the legal implication, yes, any type of 'proper' crediting would work, we are on GitHub however, so the most straight forward way, the most proper, is using gits versioning system that automatically tracks authorship.

In general, not giving credit to a contributor in any way would be the equivalent of stealing said contributors content.

This is for the same reason a copyright holder cannot just take the work of a derivative author, such as for example with music, without their permission, despite that holder being the owner of the original source material.

Another example would be the reason why repositories cannot change their license unless all contributors sign off to the change or have their code removed / replaced from the repository.

In respect to the wording, while it may be strong, I don't see it being unfit considering the amount of times people have mistakenly or otherwise done exactly what it describes, taken my work ( copy pasted ) and not credid me in any way.

The mistaken ones usually didn't even know how to accept a PR..