README Rework

[ElectronicsArchiver]

[ 
 Please Check The **Preview** 
 ][Preview]

• Add Tags

  • bullseye

  • sid

  • focal

  • impish

  
  

• Update Description

  Ungoogled Chromium packaging for Debian & Ubuntu

  
  

• Choose A License

  ⤷ https://choosealicense.com/licenses/

  
  

• Disable unused Widgets:

  • Packages

  
  

• Disable unused Tabs:

  • Projects

  
  

• Why not to use GitHub Wiki

  
  

• General formatting / spacing

• Uncompressed documentation into dedicated files

• Moved README into standard location to allow for relative links

• Added quicklinks

• Added supported release badges

• Added version number to supported releases

• Linked release histories for debian / ubuntu

• Streamlined installation instructions

• 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.     
 

[PF4Public]

What value does it bring for a barely maintained repository?

[ElectronicsArchiver]

To be more maintained.

No but what kind of question is that, changes don't change in meaning depending on how maintained the repository is.

I have used this repo many times and have been mislead by the documentation quite a bit so I thought I might as well improve it.

[PF4Public]

Sorry, if my question sounded offending, I didn't mean anything like that.

[ElectronicsArchiver]

Sorry, if my question sounded offending, I didn't mean anything like that.

I'm sorry as well~

Small writeup for design reasons:

• README only contains general points of interests such as:
  • Supported version a user could have
  • Different actions they might take ( install the package , find out more about what exactly is supported , build the packages themselves )
  • A small description of what the repository's file content entails
• The documentation is split up into bite-sized pieces that only show what is relevant to the file topic
• The installation is streamlined to have the user redirect / choose the prepeartion steps for their discribution and then continue with the non-unique updating / install-the-package part

[ghost]

Do not merge. I will review this later. I am currently trying to get this building.

[ElectronicsArchiver]

@braewoods So when is this later you were talking about?

[ghost]

I don't particularly like the approach taken here. The git root is used also for building packages directly so that was part of why I used a single file for all the documentation. In the event of a conflict between chromium and our own additions there would be problems.

Can you restructure your work under debian directory somewhere? Or even move them to a hidden folder? I also plan to remove Impish since it is EOL or close to it so I would prefer the references to it also be removed.

[ElectronicsArchiver]

I also plan to remove Impish since it is EOL or close to it so I would prefer the references to it also be removed.

Sure~

The git root is used also for building packages directly so that was part of why I used a single file for all the documentation. In the event of a conflict between chromium and our own additions there would be problems.

Well, are there any conflict even?

Also why are you building in the root anyways? Why not just have a Build folder like 99% of other projects?

Can you restructure your work under debian directory somewhere?

You want the Documentation folder in there, but the README as well?

Or even move them to a hidden folder?

.Documentation ?

[ghost]

Because this is how all Debian or Ubuntu packages are ultimately built. The debian folder is placed in the root of the upstream source code.

[ElectronicsArchiver]

How does that prevent a Build folder exactly?

The upstream would simply have to be cloned in said folder, same for the debian folder..

[ElectronicsArchiver]

Also what about the other 2 questions?

[ghost]

We used to expect people to copy the debian folder to somewhere else before attempting anything but I found it made it more difficult for me to experiment with changes and fixes.

[ghost]

Merged as a consolidated commit in another PR. For some reason a direct merge was modifying existing patches which was probably not intended.

[ElectronicsArchiver]

Merged as a consolidated commit in another PR.

So you are saying instead of telling me to reduce this commit to the documentation changes only or having me make a cherry picked branch you choose to copy paste my changes in #305?

While you @ElectronicsArchiver in the title that still robs me from the contributors history.

As you don't have an AUTHORS file I don't consider that a valid way of accepting my changes.

Please revert your pull request and let me adjust this one.

[ghost]

Reverted.

[ElectronicsArchiver]

@braewoods Thank you, I adjusted my PR branch to have the docs in .github you can open the PR again if you want.

[PF4Public]

While you @ElectronicsArchiver in the title that still robs me from the contributors history.

Is it so important to you? Are you after "contributors history" instead of "improving the documentation" after all? Why does "improving documentation" have to consist of 15 commits then?

[ElectronicsArchiver]

Why does "improving documentation" have to consist of 15 commits then?

It doesn't? I can squash them down if you want.

Is it so important to you? Are you after "contributors history" instead of "improving the documentation" after all?

Sorry I like being credited for the work I do. Or do you not like abiding by copyright law?

[PF4Public]

It doesn't? I can squash them down if you want.

Please be so kind. Also a commit message fully describing your efforts (not in 2 words) would be great. Thanks!