Create README.md

[Olf0]

Based on the experiences documented in sailfishos-chum/main#77 (comment) ff.
_{The open <ToDo> WRT changelog extraction / processing is briefly, but not at all conclusively addressed in sailfishos-patches/patchmanager#327.}

P.S.: A slightly extended version of this README is hosted as Analysis of tar_git in the Storeman wiki.

[Olf0]

Please squash-merge.

[Thaodan]

From my point of view the docs look quite good.

However the readme looks more like a summary what the code exactly does rather than an explanation of the service specific options.

E.g. the explanation regarding source names doesn't belong here as it is general behavior of obs source services. A good example for a readme is the tar_scm service's readme.md.

A shorter version of what each option does should go to the service file of the service.

[Olf0]

From my point of view the docs look quite good.

I am glad you like it.

Also this write-up has proven to be useful for me multiple times now, saving a lot of time compared to having to analyse the code each time.

However the readme looks more like a summary what the code exactly does rather than an explanation of the service specific options.

Basically "yes", because it is meant as a guide for users of tar_git respectively the Sailfish-OBS, who wonder what happens; and most of them do, because when I started using the Sailfish-OBS and asked around what the tar_git service options exactly do, all answers were "cooking recipes" à là "use this, this works for me".

As there are a few issues with the current behaviour of the service options, I expect rsp. hope that some details will change, thus this crude documentation is written close to the code with links to specific parts of it.

E.g. the explanation regarding source names doesn't belong here as it is general behavior of obs source services.

Oh, I have no idea what generic OBS behaviour is and what is tar_git specific, because the only OBS I use is the Sailfish-OBS, for which utilising tar_git seems to be mandatory.

But your statement implies that the section "Source archive name" is actually wrong, because it refers to tar_git (as first word of this section). Would the whole section be technically correct, if I exchange tar_git for "Open Build Service (OBS)"?

Still I would prefer to keep this section in for now, because it describes one of the unexpected behaviours the Sailfish-OBS shows, when one uses it for the first time without prior OBS experience. For those the difference between generic OBS and tar_git specific behaviour is indiscernible and I never came across a description of the specific treatment of source archive names when reading generic OBS documentation.

---

May I suggest, that I rectify what is technically wrong if you clearly point out what is wrong in which way (e.g. by a "Yes" to my question above or a "No" with a little explanation), then you squash-merge this PR, because it constitutes a vast improvement over the current situation: no documentation at all.

After that this README can be used as a starting point for enhancing it further, if someone has the energy and time (I don't).